The BitmapPlane Class for OpenGL(ES) with framebuffer object (FBO) support. More...

#include <GUIBitmapPlane_FBO.h>

Inheritance diagram for CGUIBitmapPlane_FBO:

Public Member Functions
eC_UInt	GetRenderSurface ()

Public Member Functions inherited from CGUIBitmapPlane_GL
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_FBO (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...

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

virtual eC_Bool	DrawToBitmap ()

virtual eC_Bool	DrawToScreen ()

Protected Member Functions inherited from CGUIBitmapPlane_GL
	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 ()

Friends
class	CGfxWrapOGL

class	CGfxWrapOGLES2

Additional Inherited Members
Protected Attributes inherited from CGUIBitmapPlane_GL
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].

Detailed Description

The BitmapPlane Class for OpenGL(ES) with framebuffer object (FBO) support.

Constructor & Destructor Documentation

◆ CGUIBitmapPlane_FBO()

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

protected

Constructor

Parameters

uiNewBitmapID	Bitmap ID
rkParentObject	Parent object
vWidth	Width
vHeight	Height

Member Function Documentation

◆ CreateRenderSurface()

virtual void CGUIBitmapPlane_FBO::CreateRenderSurface ( )

protectedvirtual

Inits the Texture Object by actually allocating memory for it.

Reimplemented from CGUIBitmapPlane_GL.

◆ DeleteRenderSurface()

virtual void CGUIBitmapPlane_FBO::DeleteRenderSurface ( )

protectedvirtual

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

Reimplemented from CGUIBitmapPlane_GL.

◆ DrawToBitmap()

virtual eC_Bool CGUIBitmapPlane_FBO::DrawToBitmap ( )

protectedvirtual

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

Returns: always true

Reimplemented from CGUIBitmapPlane_GL.

◆ DrawToScreen()

virtual eC_Bool CGUIBitmapPlane_FBO::DrawToScreen ( )

protectedvirtual

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

Returns: always true

Reimplemented from CGUIBitmapPlane_GL.

◆ GetRenderSurface()

eC_UInt CGUIBitmapPlane_FBO::GetRenderSurface ( )

Returns the internal framebuffer object

Returns: Framebuffer Object ID

Friends And Related Function Documentation

◆ CGfxWrapOGL

friend class CGfxWrapOGL

friend

◆ CGfxWrapOGLES2

friend class CGfxWrapOGLES2

friend

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

GUIBitmapPlane_FBO.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUIBitmapPlane_FBO()

Member Function Documentation

◆ CreateRenderSurface()

◆ DeleteRenderSurface()

◆ DrawToBitmap()

◆ DrawToScreen()

◆ GetRenderSurface()

Friends And Related Function Documentation

◆ CGfxWrapOGL

◆ CGfxWrapOGLES2