Inheritance diagram for iCanvas:

Detailed Description

Canvas interface.

Public Member Functions
virtual iGraphicsContext *	GetGraphicsContext () const =0
	Get the parent graphics context. {Property}. More...

virtual iImage *	GetImage () const =0
	Get the render target Image if the graphics context is a Image graphics context. {Property}. More...

virtual sRecti	GetViewport () const =0
	Get the current context's viewport. {Property}. More...

virtual sRecti	GetScissor () const =0
	Get the current context's scissor rectangle. {Property}. More...

virtual tBool	Flush ()=0
	Flush the rendering to the target immediatly. More...

virtual tBool	BlitFill (const sRectf &aDestRect, tU32 aColor)=0

virtual tBool	BlitFillAlpha (const sRectf &aDestRect, tU32 aColor)=0

virtual tBool	BlitStretch (const sRectf &aDestRect, iImage *apSrc, const sRectf &aSrcRect)=0

virtual tBool	BlitStretchAlpha (const sRectf &aDestRect, iImage *apSrc, const sRectf &aSrcRect)=0

virtual tBool	BlitStretchAlpha1 (const sRectf &aDestRect, iImage *apSrc, const sRectf &aSrcRect, tF32 afAlpha)=0

virtual tBool	BlitOverlay (const sRectf &aDestRect, iOverlay *apOverlay)=0

virtual tBool	BlitOverlayFrame (const sRectf &aDestRect, iOverlay *apOverlay, tRectFrameFlags aFrame)=0

virtual tBool	BlitLine (const sVec2f &aStart, const sVec2f &aEnd, tU32 aColor)=0

virtual tBool	BlitLineAlpha (const sVec2f &aStart, const sVec2f &aEnd, tU32 aColor)=0

virtual tBool	BlitRect (const sRectf &aDestRect, tU32 aColor)=0

virtual tBool	BlitRectAlpha (const sRectf &aDestRect, tU32 aColor)=0

virtual sRectf	BlitText (iFont apFont, const sRectf &aRect, tFontFormatFlags aFormatFlags, const achar aaszText)=0
	Blit text with the specified font. More...

virtual void	ResetStates ()=0
	Reset the canvas states to the default states. More...

virtual tBool	GetHasVertices () const =0
	Check whether any vertex has been pushed in the rendering buffer. {Property}. More...

virtual iDrawOperation *	GetDrawOperation () const =0
	Get the canvas's draw operation. {Property}. More...

virtual void	SetColorA (tU32 anColor)=0
	Set the default color A of the canvas. (default is 0xFFFFFFFF - white) {Property}. More...

virtual tU32	GetColorA () const =0
	Get the color A. {Property}. More...

virtual void	SetNormal (const sVec3f &avNormal)=0
	Set the default normal of the canvas. (default sVec3f::YAxis()) {Property}. More...

virtual sVec3f	GetNormal () const =0
	Get the default normal. {Property}. More...

virtual void	SetLineConstantScreenSize (tBool abConstSize)=0
	Set whether line have a constant size in screen space. {Property}. More...

virtual tBool	GetLineConstantScreenSize () const =0
	Get whether line have a constant size in screen space {Property}. More...

virtual void	SetLineSize (tF32 afSize)=0
	Set the line size. More...

virtual tF32	GetLineSize () const =0
	Get the line size. {Property}. More...

virtual void	SetMaterial (iMaterial *apMaterial)=0
	Set the drawop's material. {Property}. More...

virtual iMaterial *	GetMaterial () const =0
	Get the drawop's material. {Property}. More...

virtual void	SetDefaultMaterial (iTexture *apTexture, eBlendMode aBlendMode, tIntPtr aSamplerStates)=0
	Sets the default material as current material and sets its texture, blendmode and sampler states. More...

virtual void	SetMatrix (const sMatrixf &aMatrix)=0
	Set the current matrix. {Property}. More...

virtual sMatrixf	GetMatrix () const =0
	Get the current matrix. {Property}. More...

virtual void	SetBillboard (tBillboardModeFlags aMode)=0
	Set billboard mode. {Property}. More...

virtual tBillboardModeFlags	GetBillboard () const =0
	Get billboard mode. {Property}. More...

virtual void	SetBillboardRight (const sVec3f &avRight)=0
	Set the billboard right vector. More...

virtual sVec3f	GetBillboardRight () const =0
	Get the billboard right vector. {Property}. More...

virtual void	SetBillboardUp (const sVec3f &avUp)=0
	Set the billboard up vector. More...

virtual sVec3f	GetBillboardUp () const =0
	Get the billboard up vector. {Property}. More...

virtual void	SetBillboardCenter (const sVec3f &avCenter)=0
	Set the custom billboard center. {Property}. More...

virtual sVec3f	GetBillboardCenter () const =0
	Get the custom billboard center. {Property}. More...

virtual tBool	Rect (const sVec2f &avTL, const sVec2f &avBR, tF32 afZ)=0
	Push an immediate mode rectangle. More...

virtual tBool	RectT (const sVec2f &avTL, const sVec2f &avBR, const sVec2f &avTLTex, const sVec2f &avBRTex, tF32 afZ)=0
	Push an immediate mode rectangle, specifying the texture coordinates. More...

virtual tBool	RectA (const sVec2f &avTL, const sVec2f &avBR, tF32 afZ, tU32 anColA)=0
	Push an immediate mode rectangle with color A. More...

virtual tBool	RectTA (const sVec2f &avTL, const sVec2f &avBR, const sVec2f &avTLTex, const sVec2f &avBRTex, tF32 afZ, tU32 anColA)=0
	Push an immediate mode rectangle, specifying the texture coordinates and color A. More...

virtual tBool	RectTA2 (const sVec2f &avTL, const sVec2f &avBR, const sVec2f &avTLTex, const sVec2f &avBRTex, tF32 afZ, tU32 anTLColA, tU32 anTRColA, tU32 anBRColA, tU32 anBLColA)=0
	Push an immediate mode rectangle, specifying the texture coordinates, color A and Color B. More...

virtual tBool	QuadEx (const sVec3f &avTL, const sVec3f &avTLN, const sVec2f &avTLTex, tU32 anTLA, const sVec3f &avTR, const sVec3f &avTRN, const sVec2f &avTRTex, tU32 anTRA, const sVec3f &avBR, const sVec3f &avBRN, const sVec2f &avBRTex, tU32 anBRA, const sVec3f &avBL, const sVec3f &avBLN, const sVec2f &avBLTex, tU32 anBLA)=0
	Push an immediate mode quad with 3d positions, normals, texture coordinates, color A and color B. More...

virtual tBool	Quad (const sVec3f &avTL, const sVec3f &avTR, const sVec3f &avBR, const sVec3f &avBL)=0
	Push an immediate mode quad with 3d positions, texture coordinates, color A and color B. More...

virtual tBool	QuadA (const sVec3f &avTL, const sVec3f &avTR, const sVec3f &avBR, const sVec3f &avBL, tU32 anColorA)=0
	Push an immediate mode quad with 3d positions, texture coordinates, color A and color B. More...

virtual tBool	QuadA2 (const sVec3f &avTL, tU32 anTLColA, const sVec3f &avTR, tU32 anTRColA, const sVec3f &avBR, tU32 anBRColA, const sVec3f &avBL, tU32 anBLColA)=0
	Push an immediate mode quad with 3d positions, texture coordinates, color A and color B. More...

virtual tBool	QuadT (const sVec3f &avTL, const sVec2f &avTLTex, const sVec3f &avTR, const sVec2f &avTRTex, const sVec3f &avBR, const sVec2f &avBRTex, const sVec3f &avBL, const sVec2f &avBLTex)=0
	Push an immediate mode quad with 3d positions, texture coordinates, color A and color B. More...

virtual tBool	QuadTA (const sVec3f &avTL, const sVec2f &avTLTex, const sVec3f &avTR, const sVec2f &avTRTex, const sVec3f &avBR, const sVec2f &avBRTex, const sVec3f &avBL, const sVec2f &avBLTex, tU32 anColorA)=0
	Push an immediate mode quad with 3d positions, texture coordinates, color A and color B. More...

virtual tBool	QuadTA2 (const sVec3f &avTL, const sVec2f &avTLTex, tU32 anTLColA, const sVec3f &avTR, const sVec2f &avTRTex, tU32 anTRColA, const sVec3f &avBR, const sVec2f &avBRTex, tU32 anBRColA, const sVec3f &avBL, const sVec2f &avBLTex, tU32 anBLColA)=0
	Push an immediate mode quad with 3d positions, texture coordinates, color A and color B. More...

virtual tBool	Frame (tRectFrameFlags aFrame, const sVec4f &aFrameBorder, const sVec2f &avTL, const sVec2f &avBR, tF32 afZ)=0
	Push an immediate mode rectangle. More...

virtual tBool	FrameA (tRectFrameFlags aFrame, const sVec4f &aFrameBorder, const sVec2f &avTL, const sVec2f &avBR, tF32 afZ, tU32 anColA)=0
	Push an immediate mode rectangle with the specified color. More...

virtual tBool	FrameT (tRectFrameFlags aFrame, const sVec4f &aFrameBorder, const sVec2f &avTL, const sVec2f &avBR, const sVec2f &avTLTex, const sVec2f &avBRTex, tF32 afZ)=0
	Push an immediate mode rectangle, specifying the texture coordinates. More...

virtual tBool	FrameTA (tRectFrameFlags aFrame, const sVec4f &aFrameBorder, const sVec2f &avTL, const sVec2f &avBR, const sVec2f &avTLTex, const sVec2f &avBRTex, tF32 afZ, tU32 anColA)=0
	Push an immediate mode rectangle, specifying the texture coordinates and color a. More...

virtual tBool	FrameTA2 (tRectFrameFlags aFrame, const sVec4f &aFrameBorder, const sVec2f &avTL, const sVec2f &avBR, const sVec2f &avTLTex, const sVec2f &avBRTex, tF32 afZ, tU32 anTLColA, tU32 anTRColA, tU32 anBRColA, tU32 anBLColA)=0
	Push an immediate mode rectangle, specifying the texture coordinates, color A and Color B. More...

virtual tBool	Line (const sVec3f &avStart, const sVec3f &avEnd)=0
	Push a line. More...

virtual tBool	LineA (const sVec3f &avStart, const sVec3f &avEnd, tU32 anCol)=0
	Push a line. More...

virtual tBool	LineEx (const sVec3f &avStart, const sVec2f &avStartTex, tF32 afStartSize, tU32 anStartCol, const sVec3f &avEnd, const sVec2f &avEndTex, tF32 afEndSize, tU32 anEndCol)=0
	Push a line. More...

virtual tBool	WireframeCircle (const sVec3f &avCenter, tF32 afRadius, tU32 aulNumDiv=32, ePlaneType aPlane=ePlaneType_XY)=0
	Draw a circle. More...

virtual tBool	WireframeEllipse (const sVec3f &avCenter, const sVec2f &avRadius, tU32 aulNumDiv=32, ePlaneType aPlane=ePlaneType_XY)=0
	Draw an ellipse. More...

virtual tBool	WireframeAABB (const sVec3f &avMin, const sVec3f &avMax)=0
	Draw wireframe AABB. More...

virtual tBool	WireframeSphere (const sVec3f &aCenter, tF32 afRadius, tU32 aulNumDiv=32)=0
	Draw wireframe sphere. More...

virtual tBool	WireframeSphereEx (const sVec3f &aCenter, tF32 afRadius, tU32 aulNumDiv, tU32 aulColorX, tU32 aulColorY, tU32 aulColorZ)=0
	Draw wireframe sphere. More...

virtual tBool	WireframeEllipsoid (const sVec3f &aCenter, const sVec3f &avRadius, tU32 aulNumDiv=32)=0
	Draw wireframe ellipsoid. More...

virtual tBool	WireframeEllipsoidEx (const sVec3f &aCenter, const sVec3f &avRadius, tU32 aulNumDiv, tU32 aulColorX, tU32 aulColorY, tU32 aulColorZ)=0
	Draw wireframe ellipsoid. More...

virtual tBool	WireframeCone (const sVec3f &avBaseCenter, tF32 afBaseRadius, tF32 afHeight, tU32 aulNumDiv=32, ePlaneType aPlane=ePlaneType_XY)=0
	Draw a wireframe cone. More...

virtual tBool	VertexP (const sVec3f &avPosition)=0
	Push a vertex with position. More...

virtual tBool	VertexPN (const sVec3f &avPosition, const sVec3f &avNormal)=0
	Push a vertex with position and normal. More...

virtual tBool	VertexPT (const sVec3f &avPosition, const sVec2f &avTex)=0
	Push a vertex with position and a 2d texture coodinate. More...

virtual tBool	VertexPTA (const sVec3f &avPosition, const sVec2f &avTex, tU32 anColorA)=0
	Push a vertex with position, a 2d texture coodinate and color A. More...

virtual tBool	VertexPNT (const sVec3f &avPosition, const sVec3f &avNormal, const sVec2f &avTex)=0
	Push a vertex with position, normal and texture coodinate. More...

virtual tBool	VertexPNTA (const sVec3f &avPosition, const sVec3f &avNormal, const sVec2f &avTex, tU32 anColorA)=0
	Push a vertex with position, normal, texture coodinate and color A. More...

Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual iGraphicsContext* GetGraphicsContext ( ) const

pure virtual

Get the parent graphics context. {Property}.

virtual iImage* GetImage ( ) const

pure virtual

Get the render target Image if the graphics context is a Image graphics context. {Property}.

virtual sRecti GetViewport ( ) const

pure virtual

Get the current context's viewport. {Property}.

virtual sRecti GetScissor ( ) const

pure virtual

Get the current context's scissor rectangle. {Property}.

virtual tBool Flush ( )

pure virtual

Flush the rendering to the target immediatly.

virtual tBool BlitFill	(	const sRectf &	aDestRect,
		tU32	aColor
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitFillAlpha	(	const sRectf &	aDestRect,
		tU32	aColor
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitStretch	(	const sRectf &	aDestRect,
		iImage *	apSrc,
		const sRectf &	aSrcRect
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitStretchAlpha	(	const sRectf &	aDestRect,
		iImage *	apSrc,
		const sRectf &	aSrcRect
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitStretchAlpha1	(	const sRectf &	aDestRect,
		iImage *	apSrc,
		const sRectf &	aSrcRect,
		tF32	afAlpha
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitOverlay	(	const sRectf &	aDestRect,
		iOverlay *	apOverlay
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitOverlayFrame	(	const sRectf &	aDestRect,
		iOverlay *	apOverlay,
		tRectFrameFlags	aFrame
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitLine	(	const sVec2f &	aStart,
		const sVec2f &	aEnd,
		tU32	aColor
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitLineAlpha	(	const sVec2f &	aStart,
		const sVec2f &	aEnd,
		tU32	aColor
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitRect	(	const sRectf &	aDestRect,
		tU32	aColor
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual tBool BlitRectAlpha	(	const sRectf &	aDestRect,
		tU32	aColor
	)

pure virtual

Remarks: Destination is relative to the current viewport.

virtual sRectf BlitText	(	iFont *	apFont,
		const sRectf &	aRect,
		tFontFormatFlags	aFormatFlags,
		const achar *	aaszText
	)

pure virtual

Blit text with the specified font.

Remarks: Destination is relative to the current viewport.

virtual void ResetStates ( )

pure virtual

Reset the canvas states to the default states.

virtual tBool GetHasVertices ( ) const

pure virtual

Check whether any vertex has been pushed in the rendering buffer. {Property}.

virtual iDrawOperation* GetDrawOperation ( ) const

pure virtual

Get the canvas's draw operation. {Property}.

virtual void SetColorA ( tU32 anColor )

pure virtual

Set the default color A of the canvas. (default is 0xFFFFFFFF - white) {Property}.

virtual tU32 GetColorA ( ) const

pure virtual

Get the color A. {Property}.

virtual void SetNormal ( const sVec3f & avNormal )

pure virtual

Set the default normal of the canvas. (default sVec3f::YAxis()) {Property}.

virtual sVec3f GetNormal ( ) const

pure virtual

Get the default normal. {Property}.

virtual void SetLineConstantScreenSize ( tBool abConstSize )

pure virtual

Set whether line have a constant size in screen space. {Property}.

virtual tBool GetLineConstantScreenSize ( ) const

pure virtual

Get whether line have a constant size in screen space {Property}.

virtual void SetLineSize ( tF32 afSize )

pure virtual

Set the line size.

Remarks: Begin reset the default size to 1. {Property}

virtual tF32 GetLineSize ( ) const

pure virtual

Get the line size. {Property}.

virtual void SetMaterial ( iMaterial * apMaterial )

pure virtual

Set the drawop's material. {Property}.

Remarks: Sets the default blit material when apMaterial is NULL.

virtual iMaterial* GetMaterial ( ) const

pure virtual

Get the drawop's material. {Property}.

virtual void SetDefaultMaterial	(	iTexture *	apTexture,
		eBlendMode	aBlendMode,
		tIntPtr	aSamplerStates
	)

pure virtual

Sets the default material as current material and sets its texture, blendmode and sampler states.

virtual void SetMatrix ( const sMatrixf & aMatrix )

pure virtual

Set the current matrix. {Property}.

virtual sMatrixf GetMatrix ( ) const

pure virtual

Get the current matrix. {Property}.

virtual void SetBillboard ( tBillboardModeFlags aMode )

pure virtual

Set billboard mode. {Property}.

Remarks: Billboard mode influence the next rectangle/frame pushed.; If the billboard right and up vectors haven't been set they will be derived from the current the view matrix.

virtual tBillboardModeFlags GetBillboard ( ) const

pure virtual

Get billboard mode. {Property}.

virtual void SetBillboardRight ( const sVec3f & avRight )

pure virtual

Set the billboard right vector.

Remarks: If not set explicitly, the first SetBillboard(true) after Begin sets it to the current camera view matrix's right vector. {Property}

virtual sVec3f GetBillboardRight ( ) const

pure virtual

Get the billboard right vector. {Property}.

virtual void SetBillboardUp ( const sVec3f & avUp )

pure virtual

Set the billboard up vector.

Remarks: If not set explicitly, the first SetBillboard(true) after Begin sets it to the current camera view matrix's up vector. {Property}

virtual sVec3f GetBillboardUp ( ) const

pure virtual

Get the billboard up vector. {Property}.

virtual void SetBillboardCenter ( const sVec3f & avCenter )

pure virtual

Set the custom billboard center. {Property}.

virtual sVec3f GetBillboardCenter ( ) const

pure virtual

Get the custom billboard center. {Property}.

virtual tBool Rect	(	const sVec2f &	avTL,
		const sVec2f &	avBR,
		tF32	afZ
	)

pure virtual

Push an immediate mode rectangle.

virtual tBool RectT	(	const sVec2f &	avTL,
		const sVec2f &	avBR,
		const sVec2f &	avTLTex,
		const sVec2f &	avBRTex,
		tF32	afZ
	)

pure virtual

Push an immediate mode rectangle, specifying the texture coordinates.

virtual tBool RectA	(	const sVec2f &	avTL,
		const sVec2f &	avBR,
		tF32	afZ,
		tU32	anColA
	)

pure virtual

Push an immediate mode rectangle with color A.

virtual tBool RectTA	(	const sVec2f &	avTL,
		const sVec2f &	avBR,
		const sVec2f &	avTLTex,
		const sVec2f &	avBRTex,
		tF32	afZ,
		tU32	anColA
	)

pure virtual

Push an immediate mode rectangle, specifying the texture coordinates and color A.

virtual tBool RectTA2	(	const sVec2f &	avTL,
		const sVec2f &	avBR,
		const sVec2f &	avTLTex,
		const sVec2f &	avBRTex,
		tF32	afZ,
		tU32	anTLColA,
		tU32	anTRColA,
		tU32	anBRColA,
		tU32	anBLColA
	)

pure virtual

Push an immediate mode rectangle, specifying the texture coordinates, color A and Color B.

virtual tBool QuadEx	(	const sVec3f &	avTL,
		const sVec3f &	avTLN,
		const sVec2f &	avTLTex,
		tU32	anTLA,
		const sVec3f &	avTR,
		const sVec3f &	avTRN,
		const sVec2f &	avTRTex,
		tU32	anTRA,
		const sVec3f &	avBR,
		const sVec3f &	avBRN,
		const sVec2f &	avBRTex,
		tU32	anBRA,
		const sVec3f &	avBL,
		const sVec3f &	avBLN,
		const sVec2f &	avBLTex,
		tU32	anBLA
	)

pure virtual

Push an immediate mode quad with 3d positions, normals, texture coordinates, color A and color B.

virtual tBool Quad	(	const sVec3f &	avTL,
		const sVec3f &	avTR,
		const sVec3f &	avBR,
		const sVec3f &	avBL
	)

pure virtual