CGfxWrapVG Class Reference

#include <GfxWrapVG.h>

Inheritance diagram for CGfxWrapVG:

Public Member Functions
virtual void	CreateScreen ()
	Helper used to create the screen itself.
virtual void	CreateScreen (const eC_UInt &uiWidth, const eC_UInt &uiHeight)
virtual void	SetCliprect (const CGUIRect &rkNewClipRect)
Public Member Functions inherited from CGfxWrap
void	ForceRefresh ()
eC_Bool	GetDoubleBufferingEnforcesFlipping ()
eC_Bool	GetFilteredBlit () const
virtual eC_UInt	GetNOFImages ()
eC_Bool	GetOptimizedBlit () const
virtual eC_UInt	GetPhysicalScreenHeight ()=0
virtual eC_UInt	GetPhysicalScreenWidth ()=0
CGUICommonEnums::ImageType_t	GetScreenFormat () const
virtual eC_UInt	GetScreenHorizontalPPI () const
virtual eC_UInt	GetScreenVerticalPPI () const
virtual eC_UInt	GetVirtualScreenHeight ()=0
virtual eC_UInt	GetVirtualScreenWidth ()=0
eC_String	GetWrapperName () const
virtual eC_Bool	ImageExists (const ImageResource_t eID) const =0
virtual void	RestoreWrapperState ()
void	SetDoubleBufferingEnforcesFlipping (const eC_Bool bDoubleBufferingEnforcesFlipping)
virtual void	SetFilteredBlit (const eC_Bool &bFilteredBlit)
void	SetGfxEnv (CGfxEnv *pkGfxEnv)
virtual void	SetOptimizedBlit (const eC_Bool &bOptimizedBlit)
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 ()
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	Polygon (CGUIPoint *pkPoints, const eC_UInt &uiCount, 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_Bool	DrawToScreen ()
virtual eC_TArray< eC_UByte > *	GetBitmapPlaneData (const GUIBitmapPlaneID_t &eBitmapPlaneID)
virtual void	SetTargetLayer (const eC_UInt &uiLayerID)
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 (const NativeWindowType &hWindowType=0, const NativeDisplayType &hDisplayType=EGL_DEFAULT_DISPLAY)
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
	CGfxWrapVG (const NativeWindowType &hWindowType, const NativeDisplayType &hDisplayType)
virtual	~CGfxWrapVG ()
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	BlitImgExtImpl (const ImageResource_t &, 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_Bool	CheckEGLError (const eC_String &kCallingMethod)
eC_Bool	CheckVGError (const eC_String &kCallingMethod)
void	ConstructGradient (CGradient &kGradient, VGPaint &uiPaintHandle)
void	CreateBitmapImage (const eC_UInt &uiCurImage)
void	CreateSVGImage (const eC_UInt &uiCurImage)
virtual eC_Bool	DeInit (void)
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 &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2)
virtual eC_UInt	GetImageSize (const ImageResource_t &eImageID) const
virtual eC_UInt	GetImgHeightImpl (const ImageResource_t &eImageID) const
virtual eC_UInt	GetImgWidthImpl (const ImageResource_t &eImageID) const
void	GetPaintFromShape (CSVGShape &kShape, VGPaint &uiPaintHandle, eC_Bool bIsStroke)
void	GetPathFromShape (const CSVGShape &kShape, VGPath &uiPathHandle)
virtual eC_UInt	GetPhysicalScreenHeight ()
virtual eC_UInt	GetPhysicalScreenWidth ()
virtual eC_UInt	GetVirtualScreenHeight ()
virtual eC_UInt	GetVirtualScreenWidth ()
virtual eC_Bool	ImageExists (ImageResource_t eID) const
virtual eC_Bool	Init (void)
virtual void	Line (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2)
	the following methods are protected to prevent calling them directly More...
virtual void	LoadImgImpl (const eC_String &kPath, const ImageResource_t &eImageID)
virtual void	LoadImgImpl (void *pkMemory, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const CGUICommonEnums::ImageType_t &eImageType, const ImageResource_t &eID)
virtual void	Rect (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2)
virtual eC_Bool	Refresh (const RefreshCall_t eRefreshCallType)
void	RenderSVG (const eC_UInt &uiCurImage)
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)
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 eC_Bool	SetNOFImagesImpl (const eC_UInt uiNOFImages)
virtual void	UnloadImg (const ImageResource_t &eImageID)
Protected Member Functions inherited from CGfxWrap
	CGfxWrap ()
	Constructor.
virtual	~CGfxWrap (void)
	Destructor.
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)=0
void	DeInit ()
	Deinitialization.
virtual void	Ellipse (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2, const eC_Bool &bFilled)=0
virtual void	FilledRect (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2)=0
void *	GetWorkingMemory (const eC_UInt &uiSize)
virtual void	Line (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2)=0
	the following methods are protected to prevent calling them directly More...
virtual void	Polygon (eC_Value *pvPoints, const eC_UInt &uiCount, const eC_Bool &bFilled)=0
virtual void	Rect (const eC_Value &vAbsX1, const eC_Value &vAbsY1, const eC_Value &vAbsX2, const eC_Value &vAbsY2)=0
void	ReleaseWorkingMemory ()
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)=0
virtual void	SetForegroundColorImpl (const eC_UByte &ubRed, const eC_UByte &ubGreen, const eC_UByte &ubBlue, const eC_UByte &ubAlpha=255)=0
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.
virtual void	DestroyScreen ()
	Method to clean and release the screen which was created via the CreateScreen Method. More...
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	LoadImgImpl (void *pkMemory, const eC_UInt &uiWidth, const eC_UInt &uiHeight, const eC_UInt &eImageType, const ImageResource_t &eID)=0
virtual void	RefreshImage (const ImageResource_t &eID, void *pkMemory)
virtual void	BlitImgExtImpl (const CGUIImageData &kImageData, const eC_Value &vAbsDestX, const eC_Value &vAbsDestY)=0
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.
virtual CGUIBitmapPlane *	CreateGfxDependentBitmap (GUIBitmapPlaneID_t uiNewBitmapID, const CGUIObject &rkParentObject, const eC_Value &vWidth, const eC_Value &vHeight)
CGUIBitmapPlane &	GetDummyBitmap ()
virtual eC_Bool	FinishDrawToBitmap ()

Protected Attributes
EGLDisplay	m_display
	EGL-Window-handling-magic. More...
NativeDisplayType	m_hDisplayType
	the display handle
NativeWindowType	m_hWindowType
	the window handle
EGLConfig	m_offScreenConfig
	for double-buffering More...
EGLContext	m_offScreenContext
	context of offscreen-buffer
eC_TArray< CGUIImageDataVG * >	m_pkImages
	array of VGImages or SVGImages
EGLConfig	m_screenConfig
	config for buffer
EGLContext	m_screenContext
	context for buffer
EGLSurface	m_windowSurface
	window-surface for EGL
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
WorkingMemory *	m_pkWorkingMemory
	working memory
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
	constant for 2 PI

Detailed Description

specialized version of the CGfXWrapGL to handle OpenVG-acceleration

Constructor & Destructor Documentation

CGfxWrapVG()

CGfxWrapVG::CGfxWrapVG ( const NativeWindowType &  hWindowType, const NativeDisplayType &  hDisplayType  )

protected

Constructor

Parameters

[in]	hWindowType	which will be used for drawing
[in]	hDisplayType	which will be used for drawing

~CGfxWrapVG()

virtual CGfxWrapVG::~CGfxWrapVG ( )

protectedvirtual

Destructor

Member Function Documentation

Arc()

virtual void CGfxWrapVG::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  )

protectedvirtual

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.

BlitImgExtImpl()

virtual void CGfxWrapVG::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.

CheckEGLError()

eC_Bool CGfxWrapVG::CheckEGLError ( const eC_String &  kCallingMethod )

protected

check for EGL error and output message with specified method-name

Parameters

kCallingMethod

name of the calling method which is used for error-message

Returns

true if error has occurred, else false

CheckVGError()

eC_Bool CGfxWrapVG::CheckVGError ( const eC_String &  kCallingMethod )

protected

check for OpenVG error and output message with specified method-name

Parameters

kCallingMethod

name of the calling method which is used for error-message

Returns

true if error has occurred, else false

ConstructGradient()

void CGfxWrapVG::ConstructGradient ( CGradient &  kGradient, VGPaint &  uiPaintHandle  )

protected

Construct a linear or radial gradient from CGradient. gets called in void GetPaintFromShape(CSVGShape& shape, VGPaint& paint, eC_Bool bIsStroke)

Parameters

kGradient	contains infos from SVG, like color-ramp
uiPaintHandle	VGPaint-handle

CreateBitmapImage()

void CGfxWrapVG::CreateBitmapImage ( const eC_UInt &  uiCurImage )

protected

Create an bitmap image.

Parameters

uiCurImage

ID by which the image will later be accessible.

CreateInstance()

static eC_Bool CGfxWrapVG::CreateInstance ( const NativeWindowType &  hWindowType = 0, const NativeDisplayType &  hDisplayType = EGL_DEFAULT_DISPLAY  )

static

Singleton for creating a GfxWrapVG object and change the pointer in base class to this graphic wrap.

Returns

True if an instance was created by this call, otherwise False.

Parameters

[in]	hWindowType	which will be used for drawing
[in]	hDisplayType	which will be used for drawing

CreateScreen()

virtual void CGfxWrapVG::CreateScreen ( const eC_UInt &  uiWidth, const eC_UInt &  uiHeight  )

virtual

Create screen

Parameters

uiWidth
uiHeight

CreateSVGImage()

void CGfxWrapVG::CreateSVGImage ( const eC_UInt &  uiCurImage )

protected

Translate SVG-Data from GUIImageData to a OpenVG renderable form.

Parameters

uiCurImage

ID by which the image will later be accessible.

DeInit()

virtual eC_Bool CGfxWrapVG::DeInit ( void  )

protectedvirtual

Method to give the graphic library the opportunity to clean up. Connects rendering API(OpenVG) with underlying native window system with EGL.

Returns

returns True if the de-initialisation succeeded, False otherwise.

Ellipse()

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

protectedvirtual

Draws an ellipse 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 ellipse will be filled out if the last parameter is true

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.

FilledRect()

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

protectedvirtual

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.

GetImageSize()

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

protectedvirtual

Computes the size of a loaded image's raw pixel data (e.g. RGBA or RGB565, depending on platform) in memory. Needed for the Image Cache. Since this will be called by the Guiliani Image cache, derived wrappers _must not_ call NotifyImageAccess() from within this method.

Parameters

eID	The image's ID.

Returns

the size of the image in bytes

Implements CGfxWrap.

GetImgHeightImpl()

virtual eC_UInt CGfxWrapVG::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.

GetImgWidthImpl()

virtual eC_UInt CGfxWrapVG::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.

GetPaintFromShape()

void CGfxWrapVG::GetPaintFromShape ( CSVGShape &  kShape, VGPaint &  uiPaintHandle, eC_Bool  bIsStroke  )

protected

Create a VGPaint-object.

Parameters

kShape	with information about SVG-form color
uiPaintHandle	VGHandle for color and gradients
bIsStroke	determines if paint is to stoke or fill

GetPathFromShape()

void CGfxWrapVG::GetPathFromShape ( const CSVGShape &  kShape, VGPath &  uiPathHandle  )

protected

Constructs a geometry object.

Parameters

kShape	with information about SVG-form
uiPathHandle	VGPath handele to append points

GetPhysicalScreenHeight()

virtual eC_UInt CGfxWrapVG::GetPhysicalScreenHeight ( )

inlineprotectedvirtual

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.

GetPhysicalScreenWidth()

virtual eC_UInt CGfxWrapVG::GetPhysicalScreenWidth ( )

inlineprotectedvirtual

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.

GetVirtualScreenHeight()

virtual eC_UInt CGfxWrapVG::GetVirtualScreenHeight ( )

protectedvirtual

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.

GetVirtualScreenWidth()

virtual eC_UInt CGfxWrapVG::GetVirtualScreenWidth ( )

protectedvirtual

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.

ImageExists()

virtual eC_Bool CGfxWrapVG::ImageExists ( ImageResource_t  eID ) const

protectedvirtual

Returns whether the image with the given ID currently is loaded within the Graphics Wrapper. This interface must be implemented by derived graphics wrappers.

Parameters

eID	The ID to check

Returns

True if the image with the given ID is currently loaded, False otherwise.

Implements CGfxWrap.

Init()

virtual eC_Bool CGfxWrapVG::Init ( void  )

protectedvirtual

Method to initialize the graphic library. Connects rendering API(OpenVG) with underlying native window system with EGL. create context -> attached to surface -> bound to a thread(outside OpenVG) handles: paths, paints always active for one current context(except shared context) set up render quality, scissoring etc.

Returns

returns True if the initialisation succeeded, False otherwise.

Line()

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

protectedvirtual

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.

LoadImgImpl() [1/2]

virtual void CGfxWrapVG::LoadImgImpl ( const eC_String &  kPath, const ImageResource_t &  eID  )

protectedvirtual

Loads an image. This loads an image from the given path and associates it with an Image-Identifier.

Parameters

kPath	Complete path and filename of the image to be loaded.
eID	ID by which the image will later be accessible.

Implements CGfxWrap.

LoadImgImpl() [2/2]

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

protectedvirtual

load memory-image

Parameters

pkMemory
uiWidth
uiHeight
eImageType
eID

Rect()

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

protectedvirtual

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.

Refresh()

virtual eC_Bool CGfxWrapVG::Refresh ( const RefreshCall_t  eRefreshCallType )

protectedvirtual

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.

RenderSVG()

void CGfxWrapVG::RenderSVG ( const eC_UInt &  uiCurImage )

protected

Set OpenVG params and draw calls

Parameters

uiCurImage

ID by which the image will later be accessible.

Ring()

virtual void CGfxWrapVG::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  )

protectedvirtual

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.

SetCliprect()

virtual void CGfxWrapVG::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.

SetForegroundColorImpl()

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

protectedvirtual

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.

SetLineWidth()

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

protectedvirtual

Sets the line width in pixels

Parameters

vWidth

width of lines

Returns

The previous line width.

Reimplemented from CGfxWrap.

SetNOFImagesImpl()

virtual eC_Bool CGfxWrapVG::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 raised. Derived classes will have to override this method and resize their internal image-storage structures according to the new number of images which will have to be stored.

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.

UnloadImg()

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

protectedvirtual

Unloads an image. Unloads the image associated with the supplied Image-identifier and frees the memory formerly occupied by this image.

Parameters

eID	Identifier of the image to be unloaded.

Reimplemented from CGfxWrap.

Member Data Documentation

m_display

EGLDisplay CGfxWrapVG::m_display

protected

EGL-Window-handling-magic.

display for EGL

m_offScreenConfig

EGLConfig CGfxWrapVG::m_offScreenConfig

protected

for double-buffering

config of offscreen-buffer

---

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

• GfxWrapVG.h