#include <GfxEnvDAVE.h>

Inheritance diagram for CGfxEnvDAVE:

Public Member Functions
virtual void	DeInitDisplay ()

virtual void	EndOfRefresh ()

virtual void *	GetMergeBuffer () const

virtual eC_UInt	InitDisplay ()

virtual void	InitLayer (const LayerConfiguration_t &kLayerConfig)

virtual void	SetDevice (void *pkDevice)

virtual void	StartOfRefresh ()

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

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

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	CreateInstance (const SurfaceMode_t &eSurfaceMode, const CGUICommonEnums::ImageType_t &eScreenFormat, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const eC_UInt &uiBufferCount, const eC_Bool &bResizable)

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

Protected Member Functions
	CGfxEnvDAVE (const SurfaceMode_t &eSurfaceMode, const CGUICommonEnums::ImageType_t &eScreenFormat, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const eC_UInt &uiBufferCount=1, const eC_Bool &bResizable=false, const eC_Bool &bUseDisplayEmulation=false)

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)

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

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

This class implements the D/AVE-emulation of a display-controller it uses the d1-functions of D/AVE to access defined layers

it supports:

position
size
alpha-blend

Constructor & Destructor Documentation

◆ CGfxEnvDAVE()

CGfxEnvDAVE::CGfxEnvDAVE	(	const SurfaceMode_t &	eSurfaceMode,
		const CGUICommonEnums::ImageType_t &	eScreenFormat,
		const eC_UInt &	uiWidth,
		const eC_UInt &	uiHeight,
		const eC_UInt &	uiBufferCount = `1`,
		const eC_Bool &	bResizable = `false`,
		const eC_Bool &	bUseDisplayEmulation = `false`
	)

protected

Constructor

Parameters

eSurfaceMode	OpenGL or Framebuffer
eScreenFormat	screen-format
uiWidth	width
uiHeight	height
uiBufferCount	number of buffers to use
bResizable	true if resizable
bUseDisplayEmulation	true if dc-emulation should be used

Member Function Documentation

◆ CreateInstance()

static eC_Bool CGfxEnvDAVE::CreateInstance	(	const SurfaceMode_t &	eSurfaceMode,
		const CGUICommonEnums::ImageType_t &	eScreenFormat,
		const eC_UInt &	uiWidth,
		const eC_UInt &	uiHeight,
		const eC_UInt &	uiBufferCount,
		const eC_Bool &	bResizable
	)

static

Create Instance

Parameters

eSurfaceMode	surface-mode
eScreenFormat	screen-format
uiWidth	width
uiHeight	height
uiBufferCount	number of buffers to use
bResizable	true if resizable

Returns: true if successful

◆ DeInitDisplay()

virtual void CGfxEnvDAVE::DeInitDisplay ( )

virtual

De-Initialize the display sub-system

Reimplemented from CGfxEnv.

◆ EndOfRefresh()

virtual void CGfxEnvDAVE::EndOfRefresh ( )

virtual

Gets executed at the end of the refresh

Reimplemented from CGfxEnv.

◆ GetMergeBuffer()

virtual void * CGfxEnvDAVE::GetMergeBuffer ( ) const

virtual

Return the merge-buffer

Returns: buffer

Reimplemented from CGfxEnv.

◆ InitDisplay()

virtual eC_UInt CGfxEnvDAVE::InitDisplay ( )

virtual

Initialize display sub-system

Returns: returns 1 on success

Reimplemented from CGfxEnv.

◆ InitLayer()

virtual void CGfxEnvDAVE::InitLayer ( const LayerConfiguration_t & kLayerConfig )

virtual

Initialize layer-configuration

Parameters

kLayerConfig layer-configuration

Reimplemented from CGfxEnv.

◆ SetDevice()

virtual void CGfxEnvDAVE::SetDevice ( void * pkDevice )

virtual

Set the device for the wrapper

Parameters

pkDevice platform-specific device

Reimplemented from CGfxEnv.

◆ StartOfRefresh()

virtual void CGfxEnvDAVE::StartOfRefresh ( )

virtual

This will be called at the start of refresh

Reimplemented from CGfxEnv.

◆ UpdateLayer()

virtual void CGfxEnvDAVE::UpdateLayer	(	const LayerConfiguration_t &	eLayerConfig,
		const LayerUpdate_t &	eUpdateReason
	)

virtual

Update layer

Parameters

eLayerConfig	layer-configuration
eUpdateReason	reason for update

Reimplemented from CGfxEnv.

◆ UpdateLayerBuffers()

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

virtual

Refresh the layer

Parameters

uiLayerID	id of layer
pkRenderBuffer	address of render-buffer
pkDisplayBuffer	address of display-buffer
uiWidth	width of layer
uiHeight	height of layer

Returns: true if successful

Reimplemented from CGfxEnv.

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

GfxEnvDAVE.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGfxEnvDAVE()

Member Function Documentation

◆ CreateInstance()

◆ DeInitDisplay()

◆ EndOfRefresh()

◆ GetMergeBuffer()

◆ InitDisplay()

◆ InitLayer()

◆ SetDevice()

◆ StartOfRefresh()

◆ UpdateLayer()

◆ UpdateLayerBuffers()