CDisplay Class Reference

This object represents a physical display. More...

#include <CDisplay.h>

List of all members.

Public Member Functions

 CDisplay ()
 Constructs a new display object.
BOOL Init ()
 Initializes this object with specified device.
void BacklightFlash (UINT32 duration)
 Requests a flashing effect for the device's backlight.
void Blank ()
 Blank of this display.
void UnBlank ()
 Unblank of this display.
INT16 GetWidth ()
 Gets the width of this display.
INT16 GetHeight ()
 Gets the height of this display.
CGraphicsGetGraphics ()
 Gets the CGraphics object that is unique to this CDisplay.
void Flush ()
 Flushes the off-screen buffer to the display.
void Close ()
 Closes display device and frees memory.

Detailed Description

This object represents a physical display.

It includes methods for retrieving properties of the device and graphical context of the device.


Member Function Documentation

void CDisplay::BacklightFlash ( UINT32  duration  ) 

Requests a flashing effect for the device's backlight.

The flashing effect occurs for the requested duration, or it is switched off if the requested duration is zero. This method returns immediately; that is, it must not block the caller while the flashing effect is running. The device MAY limit or override the duration.

Parameters:
duration - the number of milliseconds the backlight should be flashed, or zero if the flashing should be stopped
void CDisplay::Flush (  ) 

Flushes the off-screen buffer to the display.

The size of the flushed area is equal to the size of this device. The contents of the off-screen buffer are not changed as a result of the flush operation. This method does not return until the flush has been completed, so the app may immediately begin to render the next frame to the same buffer once this method returns.

CGraphics * CDisplay::GetGraphics (  ) 

Gets the CGraphics object that is unique to this CDisplay.

Returns:
CGraphics object that application can use for painting
INT16 CDisplay::GetHeight (  ) 

Gets the height of this display.

Returns:
the height of the display
INT16 CDisplay::GetWidth (  ) 

Gets the width of this display.

Returns:
the width of the display
BOOL CDisplay::Init (  ) 

Initializes this object with specified device.

Parameters:
device_name - a name of the real display device in the system.
Returns:
true, if initialize was successfully.

The documentation for this class was generated from the following files:
Generated on Tue Jun 29 18:34:06 2010 for guilib by  doxygen 1.6.3