gem::IAdjustableBitmap Class Reference

Adjustable bitmap interface. More...

Inheritance diagram for gem::IAdjustableBitmap:

Collaboration diagram for gem::IAdjustableBitmap:

Public Member Functions
virtual Size	adjustSize (const Size &sz)=0
	Adjust bitmap size with the given recommended value.
virtual int	getDpi () const
	Get the user required dpi ( needed for text rendering ).
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

Adjustable bitmap interface.

Member Function Documentation

adjustSize()

virtual Size gem::IAdjustableBitmap::adjustSize ( const Size & sz )

pure virtual

Adjust bitmap size with the given recommended value.

The rendering engine will use the requested height and will compute an optimal width If a different height is returned then the rendering engine will carry out the calculation step again and propose a new width

Returns

The new adjusted bitmap size

Parameters

sz	The recommended size

alignment()

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

pure virtualinherited

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 virtualinherited

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 ( )

inlineinherited

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.

getDpi()

virtual int gem::IAdjustableBitmap::getDpi ( ) const

inlinevirtual

Get the user required dpi ( needed for text rendering ).

Returns

The dpi value. A value of -1 lets the SDK to choose a proper default value

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

inlineinherited

Return the bitmap memory size.

Returns

The memory size

produce()

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

staticinherited

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 virtualinherited

Get the size of the bitmap.

Returns

The size of the bitmap

stride()

int gem::IBitmap::stride ( ) const

inlineinherited

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.