Collapse all Symbian^3 Product Developer Library

CDirectScreenBitmap Class Reference

class CDirectScreenBitmap : public CBase

Direct Screen Bitmap. API to allow provide synchronisation of the display of images with the displays refresh to prevent tearing.

This is an abstract base class, so must be derived from on a per-variant basis.

Note: this class is likely to be deprecated in the future

Inherits from

CDirectScreenBitmap
- CBase

Public Member Functions
TInt	BeginUpdate(TAcceleratedBitmapInfo &)
void	Close()
TInt	Create(const TRect &, TSettingsFlags)
void	EndUpdate(TRequestStatus &)
void	EndUpdate(const TRect &, TRequestStatus &)
IMPORT_C CDirectScreenBitmap *	NewL()
IMPORT_C CDirectScreenBitmap *	NewL(TInt)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TSettingsFlags { ENone = 0, EDoubleBuffer = 1, EIncrementalUpdate = 2 }

Member Functions Documentation

BeginUpdate(TAcceleratedBitmapInfo &)

TInt

BeginUpdate

(

TAcceleratedBitmapInfo &

aBitmapInfo

)

[pure virtual]

Returns a TAcceleratedBitmapInfo referring to a bitmap which the applicationcan render to.

Parameters

TAcceleratedBitmapInfo & aBitmapInfo

The Bitmap

Close()

void

(

)

[pure virtual]

Deletes all resources associated with the CDirectScreenBitmap object.

Create(const TRect &, TSettingsFlags)

TInt	Create	(	const TRect &	aScreenRect,
			TSettingsFlags	aSettingsFlags
		)	[pure virtual]

Creates a CDirectScreenBitmap object which can be used for drawing to a region of the screen indicated by aScreenRect. This region must have previously been 'claimed' via the Window Servers Direct Screen Access API.

Parameters

const TRect & aScreenRect	The region to be displayed
TSettingsFlags aSettingsFlags	The mode of operation. The upper 3 bits are used for the screen number value: 0..7. By default the screen with number 0 will be used.

EndUpdate(TRequestStatus &)

void

EndUpdate

(

TRequestStatus &

aComplete

)

[pure virtual]

Indicates to the Video Driver that the bitmap corresponding to the update has been fully rendered. The video driver will perform the actions required to copy this to the frame buffer.

The request status aComplete will be signalled when the copying has completed.

Parameters

TRequestStatus & aComplete

Asynchronous completion status

EndUpdate(const TRect &, TRequestStatus &)

void	EndUpdate	(	const TRect &	aScreenRect,
			TRequestStatus &	aComplete
		)	[pure virtual]

Indicates to the Video Driver that the area indicated in aScreenRect has been fully rendered. The video driver will perform the actions required to copy this to the frame buffer.

The request status aComplete will be signalled when the copying has completed.

Note: aScreenRects coordinates are relative to the screen, not the update region specified in Create(). aScreenRect must fit entirely within the bounds of the original region passed to Create().

Parameters

const TRect & aScreenRect	The region to update
TRequestStatus & aComplete	Asynchronous completion status

NewL()

IMPORT_C CDirectScreenBitmap *

NewL

(

)

[static]

Constructs a CDirectScreenBitmap derived object. The default screen (with number 0) will be used.

leave: KErrNoMemory There was insufficient memory to allocate the CDirectScreenBitmap derived object

NewL(TInt)

IMPORT_C CDirectScreenBitmap *

NewL

(

TInt

aScreenNo

)

[static]

Constructs a CDirectScreenBitmap derived object.

leave: KErrNoMemory There was insufficient memory to allocate the CDirectScreenBitmap derived object

Parameters

TInt aScreenNo

Screen number, used by the CDirectScreenBitmap object.

Member Enumerations Documentation

Enum TSettingsFlags

Enumerators

ENone = 0
EDoubleBuffer = 1
EIncrementalUpdate = 2