This is the eGML implementation of the graphics wrapper. More...

#include <GfxWrapeGML.h>

Inheritance diagram for CGfxWrapeGML:

Classes
struct	ScreenConfig_t

Public Member Functions
virtual void	Arc (const eC_Value &vX1, const eC_Value &vY1, const eC_Value &vX2, const eC_Value &vY2, const eC_Value &vStartAngle, const eC_Value &vEndAngle, const eC_Value &vRotationAngle, const eC_Bool &bFilled)

virtual void	CreateScreen ()

virtual void	DestroyScreen ()
	Method to clean and release the screen which was created via the CreateScreen Method.

virtual eC_Bool	DrawToScreen ()

virtual void	Ellipse (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2, const eC_Bool &bFilled)

virtual void	FilledRect (const eC_Value &vX1, const eC_Value &vY1, const eC_Value &vX2, const eC_Value &vY2)

eC_Flag	GetBlitFlags () const

virtual eImg_Bitmap *	GetImage (const ImageResource_t &eID)

virtual eC_UInt	GetPhysicalScreenHeight ()

virtual eC_UInt	GetPhysicalScreenWidth ()

eGML_Bitmap *	GetRenderBitmap ()

eGML_Screen *	GetScreen (void)

virtual eC_UInt	GetVirtualScreenHeight ()

virtual eC_UInt	GetVirtualScreenWidth ()

virtual eC_Bool	ImageExists (const ImageResource_t eID) const

virtual void	Line (const eC_Value &vX1, const eC_Value &vY1, const eC_Value &vX2, const eC_Value &vY2)
	the following methods are protected to prevent calling them directly More...

virtual void	Rect (const eC_Value &vX1, const eC_Value &vY1, const eC_Value &vX2, const eC_Value &vY2)

virtual eC_Bool	Refresh (const RefreshCall_t eRefreshCallType)

virtual void	Ring (const eC_Value &vX1, const eC_Value &vY1, const eC_Value &vX2, const eC_Value &vY2, const eC_Value &vRingWidth, const eC_Value &vStartAngle, const eC_Value &vEndAngle, const eC_Value &vRotationAngle, const eC_Bool &bFilled)

void	SetBlitFlags (eC_Flag uiFlags)

virtual void	SetCliprect (const CGUIRect &NewAbsClipRect)

virtual void	SetFilteredBlit (const eC_Bool &bFilteredBlit)

virtual void	SetForegroundColorImpl (const eC_UByte &ubRed, const eC_UByte &ubGreen, const eC_UByte &ubBlue, const eC_UByte &ubAlpha=255)

virtual eC_Value	SetLineWidth (const eC_Value &vWidth)

virtual void	SetOptimizedBlit (const eC_Bool &bOptimizedBlit)

void	SetRenderBitmap (eGML_Bitmap *pRenderBitmap)

void	SetSubpixelEnabled (const eC_Bool bEnabled)

void	SetTargetLayer (const eC_UInt &uiLayerID)

Public Member Functions inherited from CGfxWrap
void	ForceRefresh ()

eC_Bool	GetDoubleBufferingEnforcesFlipping ()

virtual eC_UInt	GetNOFImages ()

CGUICommonEnums::ImageType_t	GetScreenFormat () const

virtual eC_UInt	GetScreenHorizontalPPI () const

virtual eC_UInt	GetScreenVerticalPPI () const

virtual eC_UByte *	GetWorkingMemory (const eC_UInt &uiSize)

eC_String	GetWrapperName () const

virtual void	ReleaseWorkingMemory (eC_UByte *pkMemory)

virtual void	ResetWorkingMemory ()

virtual void	RestoreWrapperState ()

void	SetDoubleBufferingEnforcesFlipping (const eC_Bool bDoubleBufferingEnforcesFlipping)

void	SetGfxEnv (CGfxEnv *pkGfxEnv)

void	SetScreenFormat (const CGUICommonEnums::ImageType_t &uiScreenFormat)

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

virtual void	SetWindowCaption (const eC_String &kText)

virtual void	StoreWrapperState ()

virtual void	SyncWorkingMemory ()

void	SetForegroundColor (const eC_UByte &ubRed, const eC_UByte &ubGreen, const eC_UByte &ubBlue, const eC_UByte &ubAlpha=255)

void	SetForegroundColor (const eC_UInt &uiCol)

void	UpdateGlobalAlpha (const eC_UByte &ubAlpha)

void	SetGlobalAlpha (const eC_UByte &ubAlpha)

eC_UInt	GetForegroundColor () const

eC_UByte	GetGlobalAlpha () const

eC_UByte	ApplyGlobalAlpha (const eC_UByte ubAlpha) const

void	Line (const CGUIRect &kAbsRect)

void	Rect (const CGUIRect &kAbsRect)

void	FilledRect (const CGUIRect &kAbsRect)

void	Ellipse (const CGUIRect &kAbsRect, const eC_Bool &bFilled)

void	Arc (const CGUIRect &kAbsRect, const eC_Value &vStartAngle, const eC_Value &vEndAngle, const eC_Value &vRotationAngle, const eC_Bool &bFilled)

void	Ring (const CGUIRect &kAbsRect, const eC_Value &vRingWidth, const eC_Value &vStartAngle, const eC_Value &vEndAngle, const eC_Value &vRotationAngle, const eC_Bool &bFilled)

void	Text (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_String *const lpString)

virtual void	RedrawGUI ()

virtual void	ResetCliprect ()
	Resets the clipping rectangle.

virtual void	GetCliprect (CGUIRect &AbsClipRect) const

void	InvalidateRect (const CGUIRect &kInvalidRect)

void	InvalidateRect (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2)

const CGUIRect &	GetInvalidatedRect () const

virtual void	ClearInvalidRect ()

void	BlitImg (const ImageResource_t &eID, const eC_Value &vAbsDestX, const eC_Value &vAbsDestY)

void	BlitImg (const CGUIImageData &kImageData, const eC_Value &vAbsDestX, const eC_Value &vAbsDestY)

void	BlitImgExt (const ImageResource_t &eID, const eC_Value &vAbsDestX, const eC_Value &vAbsDestY, const eC_Value &vWidth, const eC_Value &vHeight, const eC_Bool &bStretch=true, const eC_UByte &ubAlpha=255)

virtual void	BlitImgNinePatch (const ImageResource_t &eID, const CGUIRect &kAbsRect, const eC_UInt uiTopBorder, const eC_UInt uiBottomBorder, const eC_UInt uiLeftBorder, const eC_UInt uiRightBorder, const eC_UByte &ubAlpha=255)

void	BlitImgNinePatch (const ImageResource_t &eID, const CGUIRect &kAbsRect, const CGUINinePatch &kNinePatch, const eC_UByte &ubAlpha=255)

void	BlitImgExt (const ImageResource_t &eID, const CGUIRect &kAbsRect, const eC_Bool &bStretch=true, const eC_UByte &ubAlpha=255)

void	BlitImgExt (const ImageResource_t &eID, const CGUIRect &kSrcAbsRect, const CGUIRect &kDstAbsRect, const eC_UByte &ubAlpha=255)

void	BlitImgExt (const ImageResource_t &eID, const eC_UInt &uiAbsSrcX, const eC_UInt &uiAbsSrcY, const eC_UInt &uiSrcWidth, const eC_UInt &uiSrcHeight, const eC_Value &vAbsDestX, const eC_Value &vAbsDestY, const eC_Value &vDestWidth, const eC_Value &vDestHeight, const eC_UByte &ubAlpha=255, const eC_Value &vAngle=eC_FromFloat(0), const eC_Value &vRotCenterX=eC_FromFloat(0.5), const eC_Value &vRotCenterY=eC_FromFloat(0.5))

eC_UInt	GetImgWidth (const ImageResource_t &eID) const

eC_UInt	GetImgHeight (const ImageResource_t &eID) const

CGUIRect	GetImgOriginRect (const ImageResource_t &eID) const

void	SetFont (const FontResource_t &eID)

void	SetFontSpacing (const eC_Float &fSpacing)

void	RequiredSpace (const eC_String *const pkText, eC_Value &vWidth, eC_Value &vHeight)

void	FittingNumChars (const eC_String *const pkText, eC_Value vWidthMax, eC_UInt &uiNumChars, const eC_Bool &bStartAtEnd=false)

eC_Int	GetAscender () const

eC_Int	GetDescender () const

eC_Int	GetInternalLeading () const

void	GetGlyphMetrics (const eC_Char cChar, CFntWrap::GlyphMetrics_t &kMetrics)

eC_Value	GetTextXPosAdjustment (const CGUIText::HorAligned_t eHorAlignment)

eC_Value	GetTextYPosAdjustment (const CGUIText::VerAligned_t eVerAlignment)

eC_Bool	SetNOFFonts (const eC_UInt uiNOFFonts)

eC_UInt	GetNOFFonts ()

void	ChangeFont (const FontResource_t &eFontID, const eC_Char *const pcPath, const eC_UInt &uiFontSize, const CFntWrap::GUIFont_t &eFontStyle)

void	LoadFont (const FontResource_t &eFontID)

void	UnloadFont (const FontResource_t &eFontID)

virtual eC_Bool	SupportCompressedFonts () const

virtual void	LoadGlyphData (CGUIImageData pkImageData, const eC_UInt &uiGlyphWidth, const eC_UInt &uiGlyphHeight, eC_UByte pkGlyphBitmap)

virtual void	UnloadGlyphData (CGUIImageData *pkImageData)

virtual eC_Bool	DrawToBitmap (GUIBitmapPlaneID_t uiBitmapID)

virtual eC_TArray< eC_UByte > *	GetBitmapPlaneData (const GUIBitmapPlaneID_t &eBitmapPlaneID)

virtual void	SetRenderingOffset (const eC_Value &vOffsetX, const eC_Value &vOffsetY)

void	GetRenderingOffset (eC_Value &vOffsetX, eC_Value &vOffsetY)

virtual GUIBitmapPlaneID_t	CreateBitmapPlane (const CGUIObject &rkParentObject, const eC_Value &vWidth, const eC_Value &vHeight)

void	DeleteBitmapPlane (const GUIBitmapPlaneID_t uiBitmapID)

void	DeleteBitmapPlanes (const CGUIObject *pkObject)

CGUIBitmapPlane &	GetBitmapPlane (const GUIBitmapPlaneID_t uiBitmapID)

GUIBitmapPlaneID_t	GetUsedBitmapPlaneID () const

Static Public Member Functions
static eC_Bool	CreateInstance (CGfxEnv *pkGfxEnv)

Static Public Member Functions inherited from CGfxWrap
static void	DeleteInstance ()
	Delete the graphics wrapper instance.

static eC_UInt	GetNextPowerOf2 (const eC_Value &vValue)

Protected Member Functions
	CGfxWrapeGML (CGfxEnv *pkGfxEnv)

virtual	~CGfxWrapeGML (void)

virtual void	BlitImgExtImpl (const ImageResource_t &eID, const eC_UInt &uiSrcX, const eC_UInt &uiSrcY, const eC_UInt &uiSrcWidth, const eC_UInt &uiSrcHeight, const eC_Value &vDestX, const eC_Value &vDestY, const eC_Value &vDestWidth, const eC_Value &vDestHeight, const eC_UByte &ubAlpha=255, const eC_Value &vAngle=eC_FromFloat(0), const eC_Value &vRotCenterX=eC_FromFloat(0.5), const eC_Value &vRotCenterY=eC_FromFloat(0.5))

virtual void	BlitImgExtImpl (const CGUIImageData &kImageData, const eC_Value &vAbsDestX, const eC_Value &vAbsDestY)

virtual void	BlitMemoryImpl (void *pkMemory, const eC_UInt &uiAbsSrcX, const eC_UInt &uiAbsSrcY, const eC_UInt &uiSrcWidth, const eC_UInt &uiSrcHeight, const eC_Value &vAbsDestX, const eC_Value &vAbsDestY, const eC_Value &vDestWidth, const eC_Value &vDestHeight, const eC_UByte &ubAlpha=255, const eC_Value &vAngle=eC_FromFloat(0), const eC_Value &vRotCenterX=eC_FromFloat(0.5), const eC_Value &vRotCenterY=eC_FromFloat(0.5))

virtual eC_UInt	GetImageSize (const ImageResource_t &eID) const

virtual eC_UInt	GetImgHeightImpl (const ImageResource_t &eID) const

virtual eC_UInt	GetImgWidthImpl (const ImageResource_t &eID) const

virtual void	InitMainLayer ()

virtual void	LoadImgImpl (const eC_String &psPath, const ImageResource_t &eID)

virtual void	LoadImgImpl (void *pkMemory, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const eC_UInt &eImageType, const ImageResource_t &eID)

void	SetDefault2DView ()

virtual eC_Bool	SetNOFImagesImpl (const eC_UInt uiNOFImages)

virtual void	UnloadImg (const ImageResource_t &eID)

Protected Member Functions inherited from CGfxWrap
	CGfxWrap ()
	Constructor.

virtual	~CGfxWrap (void)
	Destructor.

void	DeInit ()
	Deinitialization.

virtual void	StartHandleDraw (const CGUIRect &crkClipRect)

virtual void	StartRedrawGUI ()

virtual void	EndRedrawGUI ()
	Callback which is called at the end of RedrawGUI() after all Invalidated areas were drawn and refreshed.

eC_Bool	SetNOFImages (const eC_UInt uiNOFImages)

void	LoadImg (const eC_String &kPath, const ImageResource_t &eID)

void	LoadImg (void *pkMemory, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const eC_UInt &eImageType, const ImageResource_t &eID)

virtual void	RefreshImage (const ImageResource_t &eID, void *pkMemory)

void	SetInvalidatedRect (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2)

void	SetInvalidatedRect (const CGUIRect &NewAbsRect)

void	ResetInvalidatedRect ()
	Resets the invalidated rectangle.

CGUIBitmapPlane &	GetDummyBitmap ()

virtual eC_Bool	FinishDrawToBitmap ()

Protected Attributes
eC_Bool	m_bSubpixelEnabled
	while subpixel rendering is enabled, blitting will be done with subpixel-accuracy (Resulting in a time-consuming RotBlit)

eC_Int	m_iMainLayerIndex
	index of the main-screen

eC_TArray< eImg_Bitmap * >	m_pImage
	Array of pointers to eImg bitmaps (includes alpha layer)

eGML *	m_pkEGML
	eGML instance pointer

eGML_Bitmap *	m_pkRenderBitmap
	Target bitmap for render operations in eGML.

ScreenConfig_t *	m_pkScreens
	Screens for eGML.

eC_Flag	m_uiBlitFlags
	Flags for blit operation.

eC_UInt	m_uiNumberOfScreens
	number of configured screens

Protected Attributes inherited from CGfxWrap
eC_Bool	m_bDoubleBufferingEnforcesFlipping

eC_Bool	m_bFilteredBlit
	if filtered blit is active

eC_Bool	m_bInvalidationInLastFrame

eC_Bool	m_bOptimizedBlit
	if optimized blit is active

CGUIRect	m_kClippingRect

eC_Semaphore	m_kGfxWrapSemaphore
	Semaphore to lock access to methods used in a multi thread context.

CGUIRect	m_kInvalidatedRect

eC_TListDoubleLinked< CGUIRect >	m_kInvalidatedRectList
	This is the list of invalidated rectangular regions within the GUI.

eC_TListDoubleLinked< CGUIRect >	m_kLastFrameInvalidatedRectList
	This is the list of regions which have been invalidated during the LAST frame.

eC_String	m_kWrapperName
	name of the wrapper

CGfxEnv *	m_pkGfxEnv
	pointer to the graphics-environment

eC_UByte	m_ubAlpha
	Currently set global alpha value.

eC_UInt	m_uiColor
	Currently set foreground color.

eC_UInt	m_uiNOFImages
	total number of image-objects

eC_UInt	m_uiScreenHeight
	Screen height.

eC_UInt	m_uiScreenWidth
	Screen width.

eC_Value	m_vGlobalAlphaFactor

eC_Value	m_vLineWidth
	Line width in pixels.

eC_Value	m_vRenderingOffsetX
	offset in x-direction

eC_Value	m_vRenderingOffsetY
	offset in y-direction

Additional Inherited Members
Public Types inherited from CGfxWrap
enum	RefreshCall_t { SINGLE_REFRESH, FIRST_REFRESH_OF_FRAME, INTERMEDIATE_REFRESH, LAST_REFRESH_OF_FRAME, FORCED_REFRESH }

Static Protected Attributes inherited from CGfxWrap
static const eC_Value	cvTwoPi = eC_FromFloat(6.283185307179586476925286766559f)
	constant for 2 PI

Detailed Description

This is the eGML implementation of the graphics wrapper.

This graphics wrapper uses eGML_Bitmap methods for blitting. The blit flags for all operations can be set by calling SetBlitFlags(). They are by default initialized to eGML_Bitmap::BLIT_BILINEAR.

For additional details see description of base class CGfxWrap.

Constructor & Destructor Documentation

CGfxWrapeGML::CGfxWrapeGML ( CGfxEnv * pkGfxEnv)

protected

Constructor

Parameters

pkGfxEnv

virtual CGfxWrapeGML::~CGfxWrapeGML ( void )

protectedvirtual

Destructor

Member Function Documentation

virtual void CGfxWrapeGML::Arc	(	const eC_Value &	vX1,
		const eC_Value &	vY1,
		const eC_Value &	vX2,
		const eC_Value &	vY2,
		const eC_Value &	vStartAngle,
		const eC_Value &	vEndAngle,
		const eC_Value &	vRotationAngle,
		const eC_Bool &	bFilled
	)

virtual

Draws an arc which is completly inside the rectangle described through the rectangle the top left edge at (vAbsX1, vAbsY1) and bottom right edge at (vAbsX2, vAbsY2). The arc will be filled out if the last parameter is true 0-degrees is at the mathematically correct position on the unit-circle angles are increasing in counter-clockwise direction. rotation-angle is increasing in clockwise direction, i.e. rotating by 90 degrees will result in the 0-degress being at the bottom-center

Parameters

vX1	X-coordinate of bounding rectangle's top left corner
vY1	Y-Coordinate of bounding rectangle's top left corner
vX2	X-coordinate of bounding rectangle's bottom right corner
vY2	Y-Coordinate of bounding rectangle's bottom right corner
vStartAngle	start-angle
vEndAngle	end-angle
vRotationAngle	rotation-angle
bFilled	Specifies whether the arc will be drawn outlined (false) or filled (true)

Implements CGfxWrap.

virtual void CGfxWrapeGML::BlitImgExtImpl	(	const ImageResource_t &	eID,
		const eC_UInt &	uiAbsSrcX,
		const eC_UInt &	uiAbsSrcY,
		const eC_UInt &	uiSrcWidth,
		const eC_UInt &	uiSrcHeight,
		const eC_Value &	vAbsDestX,
		const eC_Value &	vAbsDestY,
		const eC_Value &	vDestWidth,
		const eC_Value &	vDestHeight,
		const eC_UByte &	ubAlpha = `255`,
		const eC_Value &	vAngle = `eC_FromFloat(0)`,
		const eC_Value &	vRotCenterX = `eC_FromFloat(0.5)`,
		const eC_Value &	vRotCenterY = `eC_FromFloat(0.5)`
	)

protectedvirtual

Blits an image. This MUST be implemented by all graphics wrappers. It is ensured that the supplied image ID is in the valid range and is not DUMMY_IMAGE. For detailed explanations, please refer to CGfxWrap::BlitImgExt

Parameters

eID	Identifier of the image to be blitted.
uiAbsSrcX	X coordinate of upper left corner of the relevant area within the source image
uiAbsSrcY	Y coordinate of upper left corner of the relevant area within the source image
uiSrcWidth	Width of the relevant area within the source image
uiSrcHeight	Height of the relevant area within the source image
vAbsDestX	Destination X position in absolute coordinates
vAbsDestY	Destination Y position in absolute coordinates
vDestWidth	Destination width
vDestHeight	Destination height
ubAlpha	Degree of transparency. 0=transparent 255=opaque Default is opaque.
vAngle	Angle in degrees by which the image will be rotated
vRotCenterX	Rotation center X. In range of 0 to 1 (like U/V coordinates)
vRotCenterY	Rotation center Y. In range of 0 to 1 (like U/V coordinates)

Implements CGfxWrap.

virtual void CGfxWrapeGML::BlitImgExtImpl	(	const CGUIImageData &	kImageData,
		const eC_Value &	vAbsDestX,
		const eC_Value &	vAbsDestY
	)

protectedvirtual

Blits an image. This MUST be implemented by all graphics wrappers. It is ensured that the supplied image ID is in the valid range and is not DUMMY_IMAGE. For detailed explanations, please refer to CGfxWrap::BlitImgExt

Parameters

kImageData	ImageData
vAbsDestX	Destination X position in absolute coordinates
vAbsDestY	Destination Y position in absolute coordinates

Implements CGfxWrap.

virtual void CGfxWrapeGML::BlitMemoryImpl	(	void *	pkMemory,
		const eC_UInt &	uiAbsSrcX,
		const eC_UInt &	uiAbsSrcY,
		const eC_UInt &	uiSrcWidth,
		const eC_UInt &	uiSrcHeight,
		const eC_Value &	vAbsDestX,
		const eC_Value &	vAbsDestY,
		const eC_Value &	vDestWidth,
		const eC_Value &	vDestHeight,
		const eC_UByte &	ubAlpha = `255`,
		const eC_Value &	vAngle = `eC_FromFloat(0)`,
		const eC_Value &	vRotCenterX = `eC_FromFloat(0.5)`,
		const eC_Value &	vRotCenterY = `eC_FromFloat(0.5)`
	)

protectedvirtual

Blit the contents or part of content of a memory-image to the screen

Parameters

pkMemory	memory containing image-data
uiAbsSrcX	x-position in source
uiAbsSrcY	y-position in source
uiSrcWidth	width of area in source
uiSrcHeight	height of area in source
vAbsDestX	x-position in destination
vAbsDestY	y-position in destination
vDestWidth	width of destination area
vDestHeight	height of destination area
ubAlpha	alpha
vAngle	angle of rotation
vRotCenterX	x-position of center of rotation
vRotCenterY	y-position of center of rotation

static eC_Bool CGfxWrapeGML::CreateInstance ( CGfxEnv * pkGfxEnv)

static

Singleton for creating a GfxWrapeGML object and change the pointer in base class to this graphics wrapper.

Parameters

pkGfxEnv graphics-environment

Returns: Indicate whether by this call, an instance is created. The instance is created, if true, not created, otherwise.

virtual void CGfxWrapeGML::CreateScreen ( )

virtual

create a screen with given height and attributes

virtual eC_Bool CGfxWrapeGML::DrawToScreen ( )

virtual

Activates the Screen as active RenderTarget again

Returns: True if the changing was successful, otherwise False

Reimplemented from CGfxWrap.

virtual void CGfxWrapeGML::Ellipse	(	const eC_Value &	vAbsX1,
		const eC_Value &	vAbsY1,
		const eC_Value &	vAbsX2,
		const eC_Value &	vAbsY2,
		const eC_Bool &	bFilled
	)

virtual

Implementation of the CGfxWrap::Ellipse() interface for eGML. Note that eGML does currently only support filled circles (e.g. width and height must be identical), and the active foreground color must be fully opaque.

Parameters

vAbsX1	X-coordinate of bounding rectangle's top left corner
vAbsY1	Y-Coordinate of bounding rectangle's top left corner
vAbsX2	X-coordinate of bounding rectangle's bottom right corner
vAbsY2	Y-Coordinate of bounding rectangle's bottom right corner
bFilled	Specifies whether the ellipse will be drawn outlined (false) or filled (true).

Implements CGfxWrap.

virtual void CGfxWrapeGML::FilledRect	(	const eC_Value &	vAbsX1,
		const eC_Value &	vAbsY1,
		const eC_Value &	vAbsX2,
		const eC_Value &	vAbsY2
	)

virtual

Draws a filled rectangle with the top left edge at (vAbsX1, vAbsY1) and bottom right edge at (vAbsX2, vAbsY2) The bottom edge and the right edge is not included in the drawn rect. e.g. FilledRect(0, 0, 10, 10); the rect is drawn from (0,0) to (9,9) (both included).

See Also: CGUIObject::GetAbsRect()

Parameters

vAbsX1	X-coordinate of top left corner
vAbsY1	Y-Coordinate of top left corner
vAbsX2	X-coordinate of bottom right corner
vAbsY2	Y-Coordinate of bottom right corner

Implements CGfxWrap.

eC_Flag CGfxWrapeGML::GetBlitFlags ( ) const

Returns the currently set eGML blit flags.

Returns: The current combination of eGML blit flags.

See Also: SetBlitFlags()

virtual eImg_Bitmap* CGfxWrapeGML::GetImage ( const ImageResource_t & eID)

virtual

Returns a pointer to the image referenced by the specified ID.

Parameters

eID	of the image to retrieve

Returns: eImb_Bitmap pointer to the related bitmap

virtual eC_UInt CGfxWrapeGML::GetImageSize ( const ImageResource_t & eID) const

protectedvirtual

Calculates the size of an image in pixels. Called by the image cache.

Parameters

eID	id of image

Returns: size of image in pixels

Implements CGfxWrap.

virtual eC_UInt CGfxWrapeGML::GetImgHeightImpl ( const ImageResource_t & eID) const

protectedvirtual

Returns the height of an image. Must be implemented by each graphics wrapper.

Parameters

eID	The ID of the image whose width should be returned. It is ensured that eID is always in the valid range and not DUMMY_IMAGE.

Returns: The width of the image in pixels.

Implements CGfxWrap.

virtual eC_UInt CGfxWrapeGML::GetImgWidthImpl ( const ImageResource_t & eID) const

protectedvirtual

Returns the width of an image. Must be implemented by each graphics wrapper.

Parameters

eID	The ID of the image whose width should be returned. It is ensured that eID is always in the valid range and not DUMMY_IMAGE.

Returns: The width of the image in pixels.

Implements CGfxWrap.

virtual eC_UInt CGfxWrapeGML::GetPhysicalScreenHeight ( )

virtual

Returns the screen height. Will always return the physical screen height with which the GfxWrap was originally initialized. Regardless of whether the virtual screen size has been modified e.g. while drawing into a CGUIBitmapPlane.

Returns: Physical screen height

Implements CGfxWrap.

virtual eC_UInt CGfxWrapeGML::GetPhysicalScreenWidth ( )

virtual

Returns the screen width. Will always return the physical screen width with which the GfxWrap was originally initialized. Regardless of whether the virtual screen size has been modified e.g. while drawing into a CGUIBitmapPlane.

Returns: Physical screen width

Implements CGfxWrap.

eGML_Bitmap* CGfxWrapeGML::GetRenderBitmap ( )

Returns: the eGML render bitmap pointer

eGML_Screen* CGfxWrapeGML::GetScreen ( void )

Returns: the eGML screen pointer

virtual eC_UInt CGfxWrapeGML::GetVirtualScreenHeight ( )

virtual

Returns the screen height in pixels, may vary if DrawToBitmap is active. It will then return the active BitmapPlane's height instead.

See Also: GetPhysicalScreenHeight()

Returns: eC_UInt The screen height

Implements CGfxWrap.

virtual eC_UInt CGfxWrapeGML::GetVirtualScreenWidth ( )

virtual

Returns the screen width in pixels, may vary if DrawToBitmap is active. It will then return the active BitmapPlane's width instead.

See Also: GetPhysicalScreenWidth()

Returns: eC_UInt The screen width

Implements CGfxWrap.

virtual eC_Bool CGfxWrapeGML::ImageExists ( const ImageResource_t eID) const

virtual

Returns whether an image is present for the given ID.

Parameters

eID	ID for which to check

Returns: True if an image is present, False otherwise.

Implements CGfxWrap.

virtual void CGfxWrapeGML::InitMainLayer ( )

protectedvirtual

Initialize the main-layer

virtual void CGfxWrapeGML::Line	(	const eC_Value &	vAbsX1,
		const eC_Value &	vAbsY1,
		const eC_Value &	vAbsX2,
		const eC_Value &	vAbsY2
	)

virtual

the following methods are protected to prevent calling them directly

Draws a line from (vAbsX1, vAbsY1) to (vAbsX2, vAbsY2)

Parameters

vAbsX1	X-coordinate of starting point
vAbsY1	Y-Coordinate of starting point
vAbsX2	X-coordinate of ending point
vAbsY2	Y-Coordinate of ending point

Implements CGfxWrap.

virtual void CGfxWrapeGML::LoadImgImpl	(	const eC_String &	psPath,
		const ImageResource_t &	eID
	)

protectedvirtual

Loads an image file from disk. Internally called by ResourceManager.

Parameters

psPath	filename of image to load
eID	image-id which will be set

Implements CGfxWrap.

virtual void CGfxWrapeGML::LoadImgImpl	(	void *	pkMemory,
		const eC_UInt &	uiWidth,
		const eC_UInt &	uiHeight,
		const eC_UInt &	eImageType,
		const ImageResource_t &	eID
	)

protectedvirtual

Loads an image file from disk. Internally called by ResourceManager.

Parameters

pkMemory	memory-location
uiWidth
uiHeight
eImageType
eID	image-id which will be set

Implements CGfxWrap.

virtual void CGfxWrapeGML::Rect	(	const eC_Value &	vAbsX1,
		const eC_Value &	vAbsY1,
		const eC_Value &	vAbsX2,
		const eC_Value &	vAbsY2
	)

virtual

Draws a rectangle with the top left edge at (vAbsX1, vAbsY1) and bottom right edge at (vAbsX2, vAbsY2). The bottom edge and the right edge is not included in the drawn rect. e.g. Rect(0, 0, 10, 10); the rect is drawn from (0,0) to (9,9) (both included).

See Also: CGUIObject::GetAbsRect()

Parameters

vAbsX1	X-coordinate of top left corner
vAbsY1	Y-Coordinate of top left corner
vAbsX2	X-coordinate of bottom right corner
vAbsY2	Y-Coordinate of bottom right corner

Implements CGfxWrap.

virtual eC_Bool CGfxWrapeGML::Refresh ( const RefreshCall_t eRefreshCallType)

virtual

Method to bring the screen content onto the physical screen so that it becomes visible, usually via a blit operation.

Parameters

eRefreshCallType The call type of this refresh

Returns: True of the refresh was performed, False otherwise

Implements CGfxWrap.

virtual void CGfxWrapeGML::Ring	(	const eC_Value &	vX1,
		const eC_Value &	vY1,
		const eC_Value &	vX2,
		const eC_Value &	vY2,
		const eC_Value &	vRingWidth,
		const eC_Value &	vStartAngle,
		const eC_Value &	vEndAngle,
		const eC_Value &	vRotationAngle,
		const eC_Bool &	bFilled
	)

virtual

Draws a ring which is completly inside the rectangle described through the rectangle the top left edge at (vAbsX1, vAbsY1) and bottom right edge at (vAbsX2, vAbsY2). The ring will be filled out if the last parameter is true 0-degrees is at the mathematically correct position on the unit-circle angles are increasing in counter-clockwise direction. rotation-angle is increasing in clockwise direction, i.e. rotating by 90 degrees will result in the 0-degress being at the bottom-center

Parameters

vX1	X-coordinate of bounding rectangle's top left corner
vY1	Y-Coordinate of bounding rectangle's top left corner
vX2	X-coordinate of bounding rectangle's bottom right corner
vY2	Y-Coordinate of bounding rectangle's bottom right corner
vRingWidth	width of the ring
vStartAngle	start-angle
vEndAngle	end-angle
vRotationAngle	rotation-angle
bFilled	Specifies whether the ring will be drawn outlined (false) or filled (true)

Implements CGfxWrap.

void CGfxWrapeGML::SetBlitFlags ( eC_Flag uiFlags)

Sets the eGML blit flags for all blit operations.

Parameters

uiFlags Combination of eGML blit flags.

See Also: GetBlitFlags()

virtual void CGfxWrapeGML::SetCliprect ( const CGUIRect & NewAbsClipRect)

virtual

Sets a clipping rectangle. All drawing operations will be limited to the region within the clipping rectangle. This is very useful for advanced features such as soft-scrolling. Note that the clipping rectangle is not allowed to exceed the invalidated rectangle, since this would lead to visual artifacts.

Parameters

NewAbsClipRect A normalised rectangle that includes all pixels that could be drawn by the functions of the graphics wrapper. The rectangle includes the border. All pixels outside will be left untouched.

Implements CGfxWrap.

void CGfxWrapeGML::SetDefault2DView ( )

protected

Sets the default 2D view used by the gfx wrapper for 2D drawing operations, like FilledRect, Line, Blit, etc.

virtual void CGfxWrapeGML::SetFilteredBlit ( const eC_Bool & bFilteredBlit)

virtual

Enables/Disables bilinear filtering during blit operation if bilinear is available this setting is true by default

Parameters

bFilteredBlit true to enable bilinear blit, false to disable bilinear filtering and use nearest neighbor texturing

Reimplemented from CGfxWrap.

virtual void CGfxWrapeGML::SetForegroundColorImpl	(	const eC_UByte &	ubRed,
		const eC_UByte &	ubGreen,
		const eC_UByte &	ubBlue,
		const eC_UByte &	ubAlpha = `255`
	)

virtual

Sets the foreground color. This MUST be implemented by all graphics wrappers. For detailed explanations, please refer to CGfxWrap::SetForegroundColor

Parameters

ubRed	Red intensity within a range of 0 - 255
ubGreen	Green intensity within a range of 0 - 255
ubBlue	Blue intensity within a range of 0 - 255
ubAlpha	Alpha intensity within a range of 0 (transparent) - 255 (opaque)

Implements CGfxWrap.

virtual eC_Value CGfxWrapeGML::SetLineWidth ( const eC_Value & vWidth)

virtual

Sets the line width in pixels

Parameters

vWidth width of lines

Returns: The previous line width.

Reimplemented from CGfxWrap.

virtual eC_Bool CGfxWrapeGML::SetNOFImagesImpl ( const eC_UInt uiNOFImages)

protectedvirtual

Sets the total number of images. This is called internally by the ResourceManager when dynamically allocated image resources require the total number of images to be increased.

Parameters

uiNOFImages The number of images

Returns: True if internal storage has been successfully adapted to support the requested number of images. False otherwise.

Reimplemented from CGfxWrap.

virtual void CGfxWrapeGML::SetOptimizedBlit ( const eC_Bool & bOptimizedBlit)

virtual

Enables/Disables NEON optimization if neon is available this setting is true by default

Parameters

bOptimizedBlit true to enable NEON optimization if available, false to disable

Reimplemented from CGfxWrap.

void CGfxWrapeGML::SetRenderBitmap ( eGML_Bitmap * pRenderBitmap)

Parameters

pRenderBitmap The target bitmap for subsequent render operations

void CGfxWrapeGML::SetSubpixelEnabled ( const eC_Bool bEnabled)

Enables/disables subpixel rendering. (Disabled by default!) While subpixel rendering is enabled, blitting will be done with subpixel-accuracy (Resulting in a time-consuming RotBlit)

Parameters

bEnabled true to enable subpixel rendering, false to disable.

void CGfxWrapeGML::SetTargetLayer ( const eC_UInt & uiLayerID)

virtual

Parameters

uiLayerID Switch to buffer for layer for subsequent render operations

Reimplemented from CGfxWrap.

virtual void CGfxWrapeGML::UnloadImg ( const ImageResource_t & eID)

protectedvirtual

Unloads an image file. Internally called by ResourceManager.

Parameters

eID	image-id to unload

Reimplemented from CGfxWrap.

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

GfxWrapeGML.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation