gem::IBitmap Class Reference

Bitmap interface. More...

Inheritance diagram for gem::IBitmap:

Collaboration diagram for gem::IBitmap:

Public Member Functions
virtual void *	begin ()=0
	For Bitmap context: get the start address of the bitmap.
template<typename TAddr = void>
TAddr *	beginType ()
	Reinterpret the start address of the bitmap.
virtual void	end ()=0
	For Bitmap context: announce the bitmap's memory should be unlocked.
virtual Size	size () const =0
	Get the size of the bitmap.
virtual int	alignment () const =0
	Return the alignment in bytes of the bitmap's memory.
int	stride () const
	Return the image stride size.
int	memory () const
	Return the bitmap memory size.
virtual EImagePixelFormat	encoding () const =0
	Get the encoding.
virtual Rect const &	viewport () const =0
	Get the viewport rectangle associated with this rendering context.
virtual const void *	getSystemContext () const
	Get the system rendering context (platform-dependent).

Static Public Member Functions
static StrongPointer< class IAdjustableBitmap >	produce (const Size &sz, EImagePixelFormat format)
	Create a default adjustable bitmap ( SDK impl ).

Detailed Description

Bitmap interface.

Member Function Documentation

alignment()

virtual int gem::IBitmap::alignment ( ) const

pure virtual

Return the alignment in bytes of the bitmap's memory.

Common values: 1, 4, 8.

Returns

The alignment in bytes.

begin()

virtual void * gem::IBitmap::begin ( )

pure virtual

For Bitmap context: get the start address of the bitmap.

Announce the bitmap's memory should be locked.

Returns

The start address of the bitmap.

beginType()

template<typename TAddr = void>

TAddr * gem::IBitmap::beginType ( )

inline

Reinterpret the start address of the bitmap.

Template Parameters

TAddr

The type of the address

Returns

The start address of the bitmap

encoding()

virtual EImagePixelFormat gem::IRenderContext::encoding ( ) const

pure virtualinherited

Get the encoding.

Returns

The image pixel format.

getSystemContext()

virtual const void * gem::IRenderContext::getSystemContext ( ) const

inlinevirtualinherited

Get the system rendering context (platform-dependent).

Returns

The system rendering context.

memory()

int gem::IBitmap::memory ( ) const

inline

Return the bitmap memory size.

Returns

The memory size

produce()

StrongPointer< class IAdjustableBitmap > gem::IBitmap::produce ( const Size & sz, EImagePixelFormat format )

static

Create a default adjustable bitmap ( SDK impl ).

Parameters

sz	The size of the bitmap
format	The pixel format of the bitmap

Returns

The adjustable bitmap object

size()

virtual Size gem::IBitmap::size ( ) const

pure virtual

Get the size of the bitmap.

Returns

The size of the bitmap

stride()

int gem::IBitmap::stride ( ) const

inline

Return the image stride size.

Returns

The stride size

viewport()

virtual Rect const & gem::IRenderContext::viewport ( ) const

pure virtualinherited

Get the viewport rectangle associated with this rendering context.

Returns

The viewport rectangle.