#include <bitdev.h>
| class CFbsScreenDevice : public CFbsDevice |
A graphics device interface that provides direct access to the screen, without the mediation of the window server.
| IMPORT_C | ~CFbsScreenDevice | ( | ) | [virtual] |
Frees all resources owned by the object prior to its destruction.
| IMPORT_C const TUint32 * | Bits | ( | ) | const |
Returns pointer to the location of first pixel in frame buffer. Not necessarily the same as pointer to frame buffer.
Returns: Pointer to the location of first pixel or NULL if it is not accessible.
| IMPORT_C void | CancelSprite | ( | ) | const [virtual] |
Reimplemented from CFbsDevice::CancelSprite()const
This method has been deprecated. Sprites are no longer supported in BitGDI. Calling this method has no effect. Deprecated
| IMPORT_C void | ChangeScreenDevice | ( | CFbsScreenDevice * | aOldDevice | ) |
Changes the screen device.
| Parameter | Description |
|---|---|
| aOldDevice | A pointer to the old screen device. |
| IMPORT_C TDeviceOrientation | DeviceOrientation | ( | ) | const |
WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.
This function is used to request the current device orientation.
Returns: One of the TDeviceOrientation enumerated values.
| IMPORT_C TUint | DeviceOrientationsAvailable | ( | ) | const |
WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.
This function is used to request the device orientations supported by the screen device.
Returns: A bitwise combination of one or more TDeviceOrientation enumerated values indicating the device orientations that are supported by this device.
| IMPORT_C void | DrawSpriteBegin | ( | ) |
This method has been deprecated. Sprites are no longer supported in BitGDI. Calling this method has no effect. Deprecated
| IMPORT_C void | DrawSpriteEnd | ( | ) |
This method has been deprecated. Sprites are no longer supported in BitGDI. Calling this method has no effect. Deprecated
Reimplemented from CGraphicsDevice::GetPalette(CPalette *&)const
Gets the device's current palette.
This function is only supported if the device has a modifiable palette, which can be determined by calling PaletteAttributes().
| Parameter | Description |
|---|---|
| aPalette | On return, holds the devices current palette. |
Returns: KErrNone, if successful; otherwise, another of the system-wide error codes.
Reimplemented from CBitmapDevice::GetPixel(TRgb &,const TPoint &)const
Gets the RGB colour of an individual pixel on a bitmapped graphics device.
This implements the pure virtual function CBitmapDevice::GetPixel().
| IMPORT_C void | GetScanLine | ( | TDes8 & | aBuf, |
| const TPoint & | aStartPixel, | |||
| TInt | aLength, | |||
| TDisplayMode | aDispMode | |||
| ) | const [virtual] | |||
Reimplemented from CBitmapDevice::GetScanLine(TDes8 &,const TPoint &,TInt,TDisplayMode)const
Copies a scanline into a buffer.
This implements the pure virtual function CBitmapDevice::GetScanLine().
| IMPORT_C void | GetSurface | ( | TSurfaceId & | aSurface | ) | const |
WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.
Get the surface identifier for the current device orientation of the screen. If screen device doesn't support providing a surface, the caller is panicked.
| Parameter | Description |
|---|---|
| aSurface | Set to the surface identifier for the screen buffer. |
| IMPORT_C RHardwareBitmap | HardwareBitmap | ( | ) |
Creates and returns a hardware bitmap (a bitmap which can be drawn to by a graphics accelerator whose operations may be implemented in hardware or software), whose handle is to the screen.
This allows the caller to draw to the screen like any other hardware bitmap.
This function may not be supported on all hardware. If unsupported, it returns an RHardwareBitmap with a handle of zero.
The hardware bitmap can be used to draw directly to the screen. Use it to create a TAcceleratedBitmapSpec object, which can either be used to get a TAcceleratedBitmapInfo, or can be passed to a graphics operation (an instance of a class derived from class TGraphicsOperation) e.g. a bitblt to copy one part of the screen to another.
Direct screen access must only be carried out in combination with the Window Server's direct screen access classes; i.e. only use the hardware bitmap on the CFbsScreenDevice which you get from CDirectScreenAccess, and not from your own CFbsScreenDevice.
See also: TAcceleratedBitmapSpec TGraphicsOperation CGraphicsAccelerator::Operation() CDirectScreenAccess
Returns: A hardware bitmap whose handle is to the screen.
| IMPORT_C TSpriteBase * | HideSprite | ( | ) | const [virtual] |
Reimplemented from CFbsDevice::HideSprite()const
This method has been deprecated. Sprites are no longer supported in BitGDI. Calling this method has no effect.
Returns: NULL.
| IMPORT_C TSpriteBase * | HideSprite | ( | const TRect & | aRect, |
| const TRegion * | aClippingRegion | |||
| ) | const [virtual] | |||
Reimplemented from CFbsDevice::HideSprite(const TRect &,const TRegion *)const
This method has been deprecated. Sprites are no longer supported in BitGDI. Calling this method has no effect.
| Parameter | Description |
|---|---|
| aRect | Ignored. |
| aClippingRegion | Ignored. |
Returns: NULL.
Converts a horizontal dimension from pixels to twips.
This implements the pure virtual function MGraphicsDeviceMap::HorizontalPixelsToTwips().
Converts a horizontal dimension from twips to pixels.
This implements the pure virtual function MGraphicsDeviceMap::HorizontalTwipsToPixels().
| IMPORT_C CFbsScreenDevice * | NewL | ( | const TDesC & | aLibname, |
| TDisplayMode | aDispMode | |||
| ) | [static] | |||
Creates a new CFbsScreenDevice object.
| Parameter | Description |
|---|---|
| aLibname | Not used. |
| aDispMode | The display mode of the device. |
Returns: The newly created FBSERV screen device.
| IMPORT_C CFbsScreenDevice * | NewL | ( | const TDesC & | aLibname, |
| TDisplayMode | aDispMode, | |||
| TRgb | aWhite | |||
| ) | [static] | |||
Creates a new CFbsScreenDevice object.
DeprecatedUse two param version instead.
| Parameter | Description |
|---|---|
| aLibname | Not used. |
| aDispMode | The display mode of the device. |
| aWhite | Not used. |
Returns: The newly created font and bitmap server screen device.
| IMPORT_C CFbsScreenDevice * | NewL | ( | TInt | aScreenNo, |
| TDisplayMode | aDispMode | |||
| ) | [static] | |||
Creates a new CFbsScreenDevice object.
| Parameter | Description |
|---|---|
| aScreenNo | The screen number. If the device has a support for only one screen, its number is 0. |
| aDispMode | The display mode of the device. |
Returns: The newly created FBSERV screen device.
Reimplemented from CGraphicsDevice::PaletteAttributes(TBool &,TInt &)const
Gets the palette attributes of the device.
| Parameter | Description |
|---|---|
| aModifiable | On return, holds information on whether or not the device palette is modifiable (ETrue) or fixed (EFalse). |
| aNumEntries | On return, holds the number of entries in the device palette. |
| IMPORT_C TInt | ScreenNo | ( | ) | const |
Query the screen number to which the object refers.
Returns: Screen number as passed in aScreenNo to NewL.
| IMPORT_C void | SetAutoUpdate | ( | TBool | aValue | ) |
Sets or unsets auto-update for the screen.
| Parameter | Description |
|---|---|
| aValue | ETrue, if the screen is set to auto-update; EFalse, otherwise. |
| IMPORT_C TBool | SetDeviceOrientation | ( | TDeviceOrientation | aOrientation | ) | const |
WARNING: Function for internal use ONLY. Compatibility is not guaranteed in future releases.
This function selects the surface and device buffer to use in the screen driver for this screen. Normal and 180 rotations will generally use the same surface, while 90 and 270 will use another. The surfaces may have different width, height, stride and surface, so functions that make use of any of these may be affected after a change in surface orientation, and the return value should be checked for this reason.
This call does not change the way rendering is performed, but may operate on the underlying memory using a new shape. The call does not change the display controller s settings, as this is handled via the GCE. All this changes are the internal attributes of the screen device and driver objects. A CFbsBitGc object activated on the device should be reactivated, to update its own attributes, or drawing may be corrupted.
Note: while TDeviceOrientation values do not directly correspond to CFbsBitGc::TGraphicsOrientation values, and cannot be used interchangeably, it is simple to generate the former from the latter using the left-shift operator (i.e. device == (1 << graphics)). In particular a device orientation of 90 degrees clockwise is equivalent to a content orientation of 90 degrees anti- clockwise, which is what TGraphicsOrientation refers to for the equivalent setting. The letters "CW" in the TDeviceOrientation enumeration refer to a clockwise device rotation, so EDeviceOrientation90CW is a 90 degree clockwise rotation of the device.
| Parameter | Description |
|---|---|
| aOrientation | The new device orientation, relative to the normal physical screen orientation. |
Returns: ETrue is returned if any of the surface, width, height or stride attributes of the screen device have changed as a result of the call or EFalse if none of the attributes have changed.
| IMPORT_C void | SetPalette | ( | CPalette * | aPalette | ) | [virtual] |
Reimplemented from CGraphicsDevice::SetPalette(CPalette *)
Sets the device's palette to the specified palette.
Setting the palette is only possible if the device has a modifiable palette, which can be determined by calling PaletteAttributes().
| Parameter | Description |
|---|---|
| aPalette | The new palette for the device. |
| IMPORT_C void | ShowSprite | ( | TSpriteBase * | aSprite | ) | const [virtual] |
Reimplemented from CFbsDevice::ShowSprite(TSpriteBase *)const
This method has been deprecated. Sprites are no longer supported in BitGDI. Calling this method has no effect.
| Parameter | Description |
|---|---|
| aSprite | Ignored. |
| IMPORT_C void | ShowSprite | ( | TSpriteBase * | aSprite, |
| const TRect & | aRect, | |||
| const TRegion * | aClippingRegion | |||
| ) | const [virtual] | |||
Reimplemented from CFbsDevice::ShowSprite(TSpriteBase *,const TRect &,const TRegion *)const
This method has been deprecated. Sprites are no longer supported in BitGDI. Calling this method has no effect.
| Parameter | Description |
|---|---|
| aSprite | Ignored. |
| aRect | Ignored. |
| aClippingRegion | Ignored. |
| IMPORT_C TSize | SizeInTwips | ( | ) | const [virtual] |
Reimplemented from CGraphicsDevice::SizeInTwips()const
Gets the size of the device area, in twips.
This implements the pure virtual function CGraphicsDevice::SizeInTwips().
See also: CGraphicsDevice::SizeInTwips()
| IMPORT_C void | Update | ( | const TRegion & | aRegion | ) |
Forces any out of date region of the screen to update, and additionally forces the specified region to update.
| Parameter | Description |
|---|---|
| aRegion | The region of the screen to update, in addition to any out of date region. |
Converts a vertical dimension from pixels to twips.
This implements the pure virtual function MGraphicsDeviceMap::VerticalPixelsToTwips().
Converts a vertical dimension from twips to pixels.
This implements the pure virtual function MGraphicsDeviceMap::VerticalTwipsToPixels().