The BitmapPlane Class for GL with pseudo offscreen rendering. More...

#include <GUIBitmapPlane_GL.h>

Inheritance diagram for CGUIBitmapPlane_GL:

[legend]

Public Member Functions
virtual void	Clear (const eC_UByte ubRed, const eC_UByte ubGreen, const eC_UByte ubBlue, const eC_UByte ubAlpha)

void	DoDraw ()

virtual eC_Value	Get2DPlaneDistance ()

virtual eC_Value	GetBottomLeftV ()

virtual eC_Value	GetBottomRightV ()

virtual void	GetData (eC_TArray< eC_UByte > *pkData)

const eC_UInt	GetTextureID () const

virtual eC_Value	GetTopLeftV ()

virtual eC_Value	GetTopRightV ()

virtual void	SetAlphaValues (const eC_UByte ubTopLeft, const eC_UByte ubBottomLeft, const eC_UByte ubBottomRight, const eC_UByte ubTopRight)

virtual void	SetBottomLeftV (eC_Value vV)

virtual void	SetBottomRightV (eC_Value vV)

virtual void	SetHeight (eC_Value vHeight, eC_Bool bExpandCentered=false)

virtual void	SetTopLeftV (eC_Value vV)

virtual void	SetTopRightV (eC_Value vV)

virtual void	SetWidth (eC_Value vWidth, eC_Bool bExpandCentered=false)

Public Member Functions inherited from CGUIBitmapPlane
GUIBitmapPlaneID_t	GetID () const

void	SetPos2D (eC_Value vXPos, eC_Value vYPos)

void	SetXPos2D (eC_Value vXPos)

void	SetYPos2D (eC_Value vYPos)

eC_Value	GetXPos2D () const

eC_Value	GetYPos2D () const

void	SetPos3D (eC_Value vXPos, eC_Value vYPos, eC_Value vZPos)

void	SetXPos3D (const eC_Value vXPos)

void	SetYPos3D (const eC_Value vYPos)

void	SetZPos3D (const eC_Value vZPos)

eC_Value	GetXPos () const

eC_Value	GetYPos () const

eC_Value	GetZPos () const

void	RotateX (const eC_Value vXAngle)

void	RotateY (const eC_Value vYAngle)

void	RotateZ (const eC_Value vZAngle)

eC_Value	GetXAngle () const

eC_Value	GetYAngle () const

eC_Value	GetZAngle () const

void	ResetRotation ()

eC_Value	GetWidth () const

eC_Value	GetWidthCorrected () const

eC_Value	GetHeight () const

eC_Value	GetHeightCorrected () const

void	SetBytesPerPixel (const eC_UByte &ubBPP)

eC_UByte	GetBytesPerPixel () const

void	SetFormat (const CGUICommonEnums::ImageType_t &eFormat)

CGUICommonEnums::ImageType_t	GetFormat () const

void	SetAutoScale (const eC_Bool bAutoScale)

const CGUIObject &	GetParentGUIObject () const

void	SetAlphaValue (const eC_UByte ubAlpha)

virtual void	SetTopLeftU (eC_Value vU)

virtual eC_Value	GetTopLeftU ()

void	SetTopLeftUV (eC_Value vU, eC_Value vV)

virtual void	SetBottomLeftU (eC_Value vU)

virtual eC_Value	GetBottomLeftU ()

void	SetBottomLeftUV (eC_Value vU, eC_Value vV)

virtual void	SetBottomRightU (eC_Value vU)

virtual eC_Value	GetBottomRightU ()

void	SetBottomRightUV (eC_Value vU, eC_Value vV)

virtual void	SetTopRightU (eC_Value vU)

virtual eC_Value	GetTopRightU ()

void	SetTopRightUV (eC_Value vU, eC_Value vV)

void	EnableDepthTest ()

void	DisableDepthTest ()

eC_Bool	IsDepthTestEnabled () const

eC_Value	GetFOV () const

void	SetFOV (const eC_Value vFOV)

eC_Value	GetNear () const

eC_Value	GetFar () const

eC_Bool	IsYFlipped () const

Protected Member Functions
	CGUIBitmapPlane_GL (GUIBitmapPlaneID_t uiNewBitmapID, const CGUIObject &rkParentObject, eC_Value vWidth, eC_Value vHeight)

virtual void	CreateRenderSurface ()
	Inits the Texture Object by actually allocating memory for it. More...

void	CreateTexture ()
	Generates and binds a texture to this bitmap plane.

virtual void	DeleteRenderSurface ()
	Called by the framework to allow derived classes to free memory allocated by the associated render surface. More...

void	DeleteTexture ()

virtual eC_Bool	DrawToBitmap ()

virtual eC_Bool	DrawToScreen ()

void	UpdateVertices ()
	Calculates the vertices in the vertex array.

Protected Member Functions inherited from CGUIBitmapPlane
	CGUIBitmapPlane (GUIBitmapPlaneID_t uiNewBitmapID, const CGUIObject &rkParentObject, eC_Value vWidth=0, eC_Value vHeight=0)

eC_Value	GetCenterOfProjectionAbsX () const

eC_Value	GetCenterOfProjectionAbsY () const

void	SetTexUsed (eC_Value vNewTexUsedU, eC_Value vNewTexUsedV)

virtual eC_Bool	FinishDrawToBitmap ()

Protected Attributes
eC_Bool	m_bComplete
	is bitmap-plane complete

Protected Attributes inherited from CGUIBitmapPlane
eC_TArray< eC_Value >	m_avUVValues
	array containing the uv values for all four plane corners

eC_Bool	m_bAutoScale
	flag describing a bitmap plane will be automatically be scaled on GUIObject scale

eC_Bool	m_bYFlipped
	if data is upside down

eC_UInt	m_uiScreenHeight
	screen height, used to identify screen changes on calculation of 2DPlaneDistance

eC_UInt	m_uiScreenWidth
	screen width, used to identify screen changes on calculation of 2DPlaneDistance

eC_Value	m_v2DPlaneDistance
	2DPlaneDistance

eC_Value	m_vGUIObjectInitHeight
	Height of the GUIObject at creation time of this BitmapPlane.

eC_Value	m_vGUIObjectInitWidth
	Width of the GUIObject at creation time of this BitmapPlane.

eC_Value	m_vTexUsedU
	Used space/unused space in x direction in the Bitmap, due to Power of two limitations [0 1].

eC_Value	m_vTexUsedV
	Used space/unused space in y direction in the Bitmap, due to Power of two limitations [0 1].

Friends
class	CGfxWrapGL

Detailed Description

The BitmapPlane Class for GL with pseudo offscreen rendering.

Constructor & Destructor Documentation

◆ CGUIBitmapPlane_GL()

CGUIBitmapPlane_GL::CGUIBitmapPlane_GL	(	GUIBitmapPlaneID_t	uiNewBitmapID,
		const CGUIObject &	rkParentObject,
		eC_Value	vWidth,
		eC_Value	vHeight
	)

protected

Protected constructor

Parameters

uiNewBitmapID	Bitmap plane ID
rkParentObject	Parent object
vWidth	Width
vHeight	Height

Member Function Documentation

◆ Clear()

virtual void CGUIBitmapPlane_GL::Clear	(	const eC_UByte	ubRed,
		const eC_UByte	ubGreen,
		const eC_UByte	ubBlue,
		const eC_UByte	ubAlpha
	)

virtual

Clears this bitmap with the given color. Attention: Please note that clearing Alpha values is unfortunately not supported by all Graphics APIs!

Parameters

ubRed	is the red part of the clear color
ubGreen	is the green part of the clear color
ubBlue	is the blue part of the clear color
ubAlpha	is the alpha part of the clear color

Reimplemented from CGUIBitmapPlane.

◆ CreateRenderSurface()

virtual void CGUIBitmapPlane_GL::CreateRenderSurface ( )

protectedvirtual

Inits the Texture Object by actually allocating memory for it.

Reimplemented in CGUIBitmapPlane_FBO, and CGUIBitmapPlane_PBuffer.

◆ DeleteRenderSurface()

virtual void CGUIBitmapPlane_GL::DeleteRenderSurface ( )

inlineprotectedvirtual

Called by the framework to allow derived classes to free memory allocated by the associated render surface.

Reimplemented in CGUIBitmapPlane_FBO, and CGUIBitmapPlane_PBuffer.

◆ DeleteTexture()

void CGUIBitmapPlane_GL::DeleteTexture ( )

protected

Deletes the corresponding texture id

◆ DoDraw()

void CGUIBitmapPlane_GL::DoDraw ( )

virtual

Draws this BitmapPlane. The Bitmap will be drawn to the current RenderTarget, with the set rotation and position. The set cliprect also applies to this drawing.

Reimplemented from CGUIBitmapPlane.

◆ DrawToBitmap()

virtual eC_Bool CGUIBitmapPlane_GL::DrawToBitmap ( )

protectedvirtual

Called by the framework when the drawing operation into the bitmapplane is about to begin.

Returns: always true

Reimplemented from CGUIBitmapPlane.

Reimplemented in CGUIBitmapPlane_FBO, and CGUIBitmapPlane_PBuffer.

◆ DrawToScreen()

virtual eC_Bool CGUIBitmapPlane_GL::DrawToScreen ( )

protectedvirtual

Called by the framework when subsequent drawing operations shall happen on the normal UI screen.

Returns: always true

Reimplemented from CGUIBitmapPlane.

Reimplemented in CGUIBitmapPlane_FBO, and CGUIBitmapPlane_PBuffer.

◆ Get2DPlaneDistance()

virtual eC_Value CGUIBitmapPlane_GL::Get2DPlaneDistance ( )

virtual

Calculates the distance where 10, 10 rect has the size of 10, 10 pixel

Returns: z-distance of the 2D plane

Reimplemented from CGUIBitmapPlane.

◆ GetBottomLeftV()

virtual eC_Value CGUIBitmapPlane_GL::GetBottomLeftV ( )

virtual

Accessor for the lower left V value.

Returns: U value of the lower left corner of the bitmap plane.

Reimplemented from CGUIBitmapPlane.

◆ GetBottomRightV()

virtual eC_Value CGUIBitmapPlane_GL::GetBottomRightV ( )

virtual

Accessor for the lower right V value.

Returns: U value of the lower right corner of the bitmap plane.

Reimplemented from CGUIBitmapPlane.

◆ GetData()

virtual void CGUIBitmapPlane_GL::GetData ( eC_TArray< eC_UByte > * pkData )

virtual

Return the data in an array

Parameters

pkData

Reimplemented from CGUIBitmapPlane.

◆ GetTextureID()

const eC_UInt CGUIBitmapPlane_GL::GetTextureID ( ) const

Accessor for the OpenGL Texture ID.

Returns: ID of the OpenGL texture

◆ GetTopLeftV()

virtual eC_Value CGUIBitmapPlane_GL::GetTopLeftV ( )

virtual

Accessor for the upper left V value.

Returns: U value of the upper left corner of the bitmap plane.

Reimplemented from CGUIBitmapPlane.

◆ GetTopRightV()

virtual eC_Value CGUIBitmapPlane_GL::GetTopRightV ( )

virtual

Accessor for the upper right V value.

Returns: U value of the upper right corner of the bitmap plane.

Reimplemented from CGUIBitmapPlane.

◆ SetAlphaValues()

virtual void CGUIBitmapPlane_GL::SetAlphaValues	(	const eC_UByte	ubTopLeft,
		const eC_UByte	ubBottomLeft,
		const eC_UByte	ubBottomRight,
		const eC_UByte	ubTopRight
	)

virtual

Sets the alpha values for all corners of the Bitmap plane.

Parameters

ubTopLeft	alpha value for the upper left corner
ubBottomLeft	alpha value for the lower left corner
ubBottomRight	alpha value for the lower right corner
ubTopRight	alpha value for the upper right corner

Reimplemented from CGUIBitmapPlane.

◆ SetBottomLeftV()

virtual void CGUIBitmapPlane_GL::SetBottomLeftV ( eC_Value vV )

virtual

Sets the V Value of the lower left corner of the BitmapPlane. The V value describes which point of the Bitmap is mapped onto the plane in y direction. The value has to be between 0 and 1, where zero means the lower left corner of the plane maps directly on the upper edge of the bitmap and 1 the lower left corner maps on the lower edge of the bitmap. All values in between will be interpolated.

Parameters

vV	new V value for the lower left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetBottomRightV()

virtual void CGUIBitmapPlane_GL::SetBottomRightV ( eC_Value vV )

virtual

Sets the V Value of the lower left corner of the BitmapPlane. The V value describes which point of the Bitmap is mapped onto the plane in y direction. The value has to be between 0 and 1, where zero means the lower left corner of the plane maps directly on the upper edge of the bitmap and 1 the lower left corner maps on the lower edge of the bitmap. All values in between will be interpolated.

Parameters

vV	new V value for the lower left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetHeight()

virtual void CGUIBitmapPlane_GL::SetHeight	(	eC_Value	vHeight,
		eC_Bool	bExpandCentered = `false`
	)

virtual

Setter for the height.

Parameters

vHeight	new height of this BitmapPlane.
bExpandCentered	if true Plane will be expanded to top and bottom, otherwise only to the bottom. default is false

Reimplemented from CGUIBitmapPlane.

◆ SetTopLeftV()

virtual void CGUIBitmapPlane_GL::SetTopLeftV ( eC_Value vV )

virtual

Sets the V Value of the upper left corner of the BitmapPlane. The V value describes which point of the Bitmap is mapped onto the plane in y direction. The value has to be between 0 and 1, where zero means the upper left corner of the plane maps directly on the upper edge of the bitmap and 1 the upper left corner maps on the lower edge of the bitmap. All values in between will be interpolated.

Parameters

vV	new V value for the upper left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetTopRightV()

virtual void CGUIBitmapPlane_GL::SetTopRightV ( eC_Value vV )

virtual

Sets the V Value of the upper right corner of the BitmapPlane. The V value describes which point of the Bitmap is mapped onto the plane in y direction. The value has to be between 0 and 1, where zero means the upper right corner of the plane maps directly on the upper edge of the bitmap and 1 the upper right corner maps on the lower edge of the bitmap. All values in between will be interpolated.

Parameters

vV	new V value for the upper left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetWidth()

virtual void CGUIBitmapPlane_GL::SetWidth	(	eC_Value	vWidth,
		eC_Bool	bExpandCentered = `false`
	)

virtual

Setter for the width. The scale parameter which will be used for the autoscale mechanism will be updated.

Parameters

vWidth	new width of this BitmapPlane.
bExpandCentered	if true Plane will be expanded to left and right, otherwise only to the right. default is false

Reimplemented from CGUIBitmapPlane.

Friends And Related Function Documentation

◆ CGfxWrapGL

friend class CGfxWrapGL

friend

The documentation for this class was generated from the following file:

GUIBitmapPlane_GL.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CGUIBitmapPlane_GL()

Member Function Documentation

◆ Clear()

◆ CreateRenderSurface()

◆ DeleteRenderSurface()

◆ DeleteTexture()

◆ DoDraw()

◆ DrawToBitmap()

◆ DrawToScreen()

◆ Get2DPlaneDistance()

◆ GetBottomLeftV()

◆ GetBottomRightV()

◆ GetData()

◆ GetTextureID()

◆ GetTopLeftV()

◆ GetTopRightV()

◆ SetAlphaValues()

◆ SetBottomLeftV()

◆ SetBottomRightV()

◆ SetHeight()

◆ SetTopLeftV()

◆ SetTopRightV()

◆ SetWidth()

Friends And Related Function Documentation

◆ CGfxWrapGL