Wrapper class for the EGL interface. More...

#include <GfxEnvEGL.h>

Inheritance diagram for CGfxEnvEGL:

Public Member Functions
	CGfxEnvEGL (const eC_UInt &uiVersion, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const NativeWindowType &hWindowType, const NativeDisplayType &hDisplayType)

virtual	~CGfxEnvEGL ()

const EGLDisplay	GetDisplay () const

const EGLConfig	GetOffScreenConfig () const

const EGLContext	GetOffScreenContext () const

const EGLConfig	GetScreenConfig () const

const EGLContext	GetScreenContext () const

const EGLSurface	GetWindowSurface () const

virtual eC_Bool	SwapBuffers ()

Public Member Functions inherited from CGfxEnv
eC_Bool	AddLayer (const LayerConfiguration_t &kLayerConfig)

void	AddMainLayer (const eC_UInt &uiLayerID=0, const eC_Bool &bCached=false)

eC_UByte	ApplyGlobalAlpha (const eC_UByte &ubAlpha) const

virtual void	DeInitDisplay ()

virtual void	EndOfRefresh ()

eC_UInt	GetActiveLayerID () const

virtual eC_UByte	GetBPP () const

virtual eC_UInt	GetBufferCount () const

eC_UByte	GetBytesPerPixel (const CGUICommonEnums::ImageType_t &ePixFormat) const

virtual CGUICommonEnums::ImageType_t	GetColorFormat () const

void *	GetDisplayBuffer (const eC_UInt &uiLayerID) const

virtual void **	GetFrameBuffers () const

eC_UByte	GetGlobalAlpha () const

virtual eC_UInt	GetHeight () const

eC_UByte	GetLayerAlpha (const eC_UInt &uiLayerID) const

eC_Bool	GetLayerBufferSize (const eC_UInt &uiLayerID, eC_UInt &uiWidth, eC_UInt &uiHeight, eC_UByte &ubBPP)

eC_Bool	GetLayerChromaKey (const eC_UInt &uiLayerID, eC_Bool &bChromaKeyActive, eC_UInt &uiChromaKey, eC_UByte &ubAlpha) const

eC_Bool	GetLayerConfig (const eC_UInt &uiLayerIndex, LayerConfiguration_t &rkLayerConfig) const

eC_Bool	GetLayerConfigForID (const eC_UInt &uiLayerID, LayerConfiguration_t &rkLayerConfig) const

eC_Bool	GetLayerConfigForMainLayer (LayerConfiguration_t &rkLayerConfig) const

eC_Bool	GetLayerIndexForID (const eC_UInt &uiLayerID, eC_UInt &ruiLayerIndex) const

eC_Bool	GetLayerPosition (const eC_UInt &uiLayerID, eC_Int &iXPos, eC_Int &iYPos)

eC_Bool	GetLayerVisibleSize (const eC_UInt &uiLayerID, eC_UInt &uiWidth, eC_UInt &uiHeight)

eC_UInt	GetMainLayerID () const

virtual void *	GetMergeBuffer () const

eC_UInt	GetNumberOfLayers () const

void *	GetRenderBuffer (const eC_UInt &uiLayerID) const

virtual SurfaceMode_t	GetSurfaceMode () const

virtual eC_UInt	GetWidth () const

virtual eC_UInt	InitDisplay ()

void	InitLayers ()

void	InvalidateLayer (const eC_UInt &uiLayerID)

virtual eC_Bool	IsCreated () const

eC_Bool	IsLayerModified (const eC_UInt &uiLayerID) const

eC_Bool	IsLayerVisible (const eC_UInt &uiLayerID) const

eC_Bool	IsMainLayer (const eC_UInt &uiLayerID) const

virtual eC_Bool	IsNull ()

virtual eC_Bool	IsResizable () const

virtual eC_Bool	IsVSyncEnabled () const

virtual eC_Bool	NeedsManualMerge () const

virtual eC_Bool	RefreshScreen (const CGUIRect &rkInvalidatedArea)

virtual eC_Bool	RefreshScreen (const eC_TListDoubleLinked< CGUIRect > &kInvalidatedRectList)

eC_Bool	SetActiveLayerID (const eC_UInt &uiLayerID, const eC_Bool &bMarkAsModified=false)

virtual void	SetCliprect (const CGUIRect &rkNewClipRect)

virtual void	SetDevice (void *pkDevice)

void	SetGfxWrap (CGfxWrap *pkGfxWrap)

void	SetGlobalAlpha (const eC_UByte &ubGlobalAlpha)

eC_Bool	SetLayerAlpha (const eC_UInt &uiLayerID, const eC_UByte &ubAlpha)

eC_Bool	SetLayerChromaKey (const eC_UInt &uiLayerID, const eC_Bool &bChromaKeyActive, const eC_UInt &uiChromaKey, const eC_UByte &ubAlpha)

eC_Bool	SetLayerPosition (const eC_UInt &uiLayerID, const eC_Int &iXPos, const eC_Int &iYPos)

eC_Bool	SetLayerVisible (const eC_UInt &uiLayerID, const eC_Bool &bVisible)

eC_Bool	SetLayerVisiblePos (const eC_UInt &uiLayerID, const eC_Int &iXPos, const eC_Int &iYPos)

eC_Bool	SetLayerVisibleSize (const eC_UInt &uiLayerID, const eC_UInt &uiWidth, const eC_UInt &uiHeight)

void	SetMainLayerID (const eC_UInt &uiLayerID)

void	SetMainLayerProperties (const eC_UInt &uiLayerID, const eC_Bool &bCached)

void	SetObjectForLayerID (const eC_UInt &uiLayerID, CGUIObject *pkObject)

virtual void	SetScreenSize (const eC_UInt &uiWidth, const eC_UInt &uiHeight)

virtual void	SetVSyncEnabled (const eC_Bool &bVSyncEnabled)

virtual void	SetWindowCaption (const eC_String &kCaption)

virtual void	StartOfRefresh ()

virtual eC_Bool	SupportsCopy () const

virtual eC_Bool	SwapBuffers ()

virtual void	UpdateLayer (const LayerConfiguration_t &kLayerConfig, const LayerUpdate_t &eUpdateReason)

virtual eC_Bool	UpdateLayerBuffers (const eC_UInt &uiLayerID, void pkRenderBuffer, void pkDisplayBuffer, const eC_UInt &uiWidth, const eC_UInt &uiHeight)

void	UpdateLayerPositions ()

Static Public Member Functions
static eC_Bool	CheckEGLError (const eC_String &kCallingMethod)

static eC_Bool	CreateInstance (const eC_UInt &uiVersion, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const NativeWindowType &hWindowType=0, const NativeDisplayType &hDisplayType=EGL_DEFAULT_DISPLAY)

Static Public Member Functions inherited from CGfxEnv
static eC_Bool	CreateInstance (const SurfaceMode_t &eSurfaceMode, const CGUICommonEnums::ImageType_t &eScreenFormat, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const eC_UInt &uiBufferCount=1, void **ppkBuffers=NULL, const eC_Bool &bResizable=false)

static void	DeleteInstance ()
	called to destroy and detach GfxEnv

Additional Inherited Members
Public Types inherited from CGfxEnv
enum	SurfaceMode_t { SM_OPENGL , SM_FRAMEBUFFER }

Protected Member Functions inherited from CGfxEnv
	CGfxEnv (const SurfaceMode_t &eSurfaceMode, const CGUICommonEnums::ImageType_t &eScreenFormat, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const eC_UInt &uiBufferCount=1, void **ppkBuffers=NULL, const eC_Bool &bResizable=false)

virtual	~CGfxEnv ()

eC_UByte	GetBPPFromScreenFormat () const

virtual void	InitLayer (const LayerConfiguration_t &kLayerConfig)

void	UpdateMainLayer (const CGUICommonEnums::ImageType_t &eColorFormat, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const eC_UInt &uiBufferCount, void **ppkBuffers)

Protected Attributes inherited from CGfxEnv
eC_TArray< LayerConfiguration_t >	m_akLayers
	: *DCLayer_t, one DCLayer_t struct per layer storing general settings

eC_Bool	m_bNeedsManualMerge
	if supports merge

eC_Bool	m_bResizable
	resizable

eC_Bool	m_bSupportsCopy
	if supports copy

eC_Bool	m_bVSyncEnabled
	if vsync is enabled

CGUICommonEnums::ImageType_t	m_eColorFormat
	color-format

SurfaceMode_t	m_eSurfaceMode
	surface mode

eC_Int	m_iMainLayerID
	id of main-layer

CGfxWrap *	m_pkGfxWrap
	pointer to GfxWrapper

void **	m_ppkBuffers
	buffers for the main-screen

eC_UByte	m_ubBPP
	BPP of the surface.

eC_UByte	m_ubGlobalAlpha
	global alpha for blending

eC_UInt	m_uiActiveLayerID
	: unsigned int = Active Layer

eC_UInt	m_uiActiveLayerIndex
	index of currentl< active layer

eC_UInt	m_uiBufferCount
	number of buffers used

eC_UInt	m_uiHeight
	height of the surface

eC_UInt	m_uiWidth
	width of the surface

Detailed Description

Wrapper class for the EGL interface.

The official EGL Specification released by Khronos states in Appendix D Version 1.3 "For naming consistency, some tokens from EGL 1.2 have been renamed [...] The old names are also retained for backwards compatibility." Unfortunately this is not implemented for some SDKs. The following definitions resolve this incompatibility. This provides a graphics-environment based on EGL

Constructor & Destructor Documentation

◆ CGfxEnvEGL()

CGfxEnvEGL::CGfxEnvEGL	(	const eC_UInt &	uiVersion,
		const eC_UInt &	uiWidth,
		const eC_UInt &	uiHeight,
		const NativeWindowType &	hWindowType,
		const NativeDisplayType &	hDisplayType
	)

Constructor

Parameters

[in]	uiVersion	OpenGL ES version to instantiate
[in]	uiWidth	widht
[in]	uiHeight	height
[in]	hWindowType	Window handle
[in]	hDisplayType	Display handle

◆ ~CGfxEnvEGL()

virtual CGfxEnvEGL::~CGfxEnvEGL ( )

virtual

Destructor

Member Function Documentation

◆ CheckEGLError()

static eC_Bool CGfxEnvEGL::CheckEGLError ( const eC_String & kCallingMethod )

static

Checks for EGL error and prints the error code.

Parameters

[in] kCallingMethod Method name which calls this function. Used to print the method name.

Returns: True if there is an error, False otherwise

◆ CreateInstance()

static eC_Bool CGfxEnvEGL::CreateInstance	(	const eC_UInt &	uiVersion,
		const eC_UInt &	uiWidth,
		const eC_UInt &	uiHeight,
		const NativeWindowType &	hWindowType = `0`,
		const NativeDisplayType &	hDisplayType = `EGL_DEFAULT_DISPLAY`
	)

static

Create an instance

Parameters

[in]	uiVersion	OpenGL ES version to instantiate
[in]	uiWidth	widht
[in]	uiHeight	height
[in]	hWindowType	Window handle
[in]	hDisplayType	Display handle

Returns: true if successful

◆ GetDisplay()

const EGLDisplay CGfxEnvEGL::GetDisplay ( ) const

inline

Returns the EGL display handle.

Returns: EGL display handle

◆ GetOffScreenConfig()

const EGLConfig CGfxEnvEGL::GetOffScreenConfig ( ) const

inline

Returns the offscreen config.

Returns: Offscreen config

◆ GetOffScreenContext()

const EGLContext CGfxEnvEGL::GetOffScreenContext ( ) const

inline

Returns the offscreen context.

Returns: Offscreen context

◆ GetScreenConfig()

const EGLConfig CGfxEnvEGL::GetScreenConfig ( ) const

inline

Returns the screen config.

Returns: Screen config

◆ GetScreenContext()

const EGLContext CGfxEnvEGL::GetScreenContext ( ) const

inline

Returns the screen context.

Returns: Screen context

◆ GetWindowSurface()

const EGLSurface CGfxEnvEGL::GetWindowSurface ( ) const

inline

Returns the EGL window surface.

Returns: EGL window surface

◆ SwapBuffers()

virtual eC_Bool CGfxEnvEGL::SwapBuffers ( )

virtual

Swap buffers

Returns: true if successful

Reimplemented from CGfxEnv.

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

GfxEnvEGL.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGfxEnvEGL()

◆ ~CGfxEnvEGL()

Member Function Documentation

◆ CheckEGLError()

◆ CreateInstance()

◆ GetDisplay()

◆ GetOffScreenConfig()

◆ GetOffScreenContext()

◆ GetScreenConfig()

◆ GetScreenContext()

◆ GetWindowSurface()

◆ SwapBuffers()