CBitwiseBitmap Class Reference
| Public Member Functions |
|---|
| IMPORT_C TInt | CheckBackgroundCompressData() |
| IMPORT_C TInt | CompressData() |
| IMPORT_C TInt | CompressData(TBitmapfileCompressionScheme) |
| IMPORT_C TInt | DataStride() |
| IMPORT_C TDisplayMode | DisplayMode() |
| IMPORT_C void | ExternalizeL(RWriteStream &, const CFbsBitmap &) |
| IMPORT_C void | ExternalizeRectangleL(RWriteStream &, const TRect &, const CFbsBitmap &) |
| IMPORT_C void | GetPixel(TRgb &, const TPoint &, TUint32 *, CFbsRasterizer *) |
| IMPORT_C void | GetScanLine(TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *, TLineScanningPosition &) |
| IMPORT_C void | GetScanLine(TUint32 *&, TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode) |
| IMPORT_C void | GetScanLine(TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *) |
| IMPORT_C TInt | GetScanLinePtr(TUint32 *&, TPoint &, TInt, TUint32 *, TLineScanningPosition &) |
| IMPORT_C TInt | GetScanLinePtr(TUint32 *&, TInt &, TPoint &, TUint32 *, TLineScanningPosition &) |
| IMPORT_C void | GetVerticalScanLine(TDes8 &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *, CFbsRasterizer *) |
| IMPORT_C TInt | HardwareBitmapHandle() |
| IMPORT_C SEpocBitmapHeader | Header() |
| IMPORT_C TInt | HorizontalPixelsToTwips(TInt) |
| IMPORT_C TInt | HorizontalTwipsToPixels(TInt) |
| IMPORT_C void | InternalizeHeaderL(RReadStream &, SEpocBitmapHeader &) |
| IMPORT_C void | InternalizeL(RReadStream &) |
| IMPORT_C TBool | IsCompressed() |
| IMPORT_C TBool | IsCompressedInRAM() |
| IMPORT_C TBool | IsLargeBitmap() |
| IMPORT_C TBool | IsMonochrome(TUint32 *) |
| IMPORT_C TUint32 * | ScanLineAddress(TUint32 *, TUint) |
| IMPORT_C void | SetCompressionBookmark(TLineScanningPosition &, TUint32 *, const CFbsBitmap *) |
| IMPORT_C TSize | SizeInPixels() |
| IMPORT_C TSize | SizeInTwips() |
| IMPORT_C void | StretchScanLine(TDes8 &, const TPoint &, TInt, TInt, TInt, TInt, TInt, const TPoint &, TDisplayMode, TUint32 *) |
| IMPORT_C void | StretchScanLine(TDes8 &, const TPoint &, TInt, TInt, TInt, TInt, TInt, const TPoint &, TDisplayMode, TUint32 *, TLineScanningPosition &) |
| IMPORT_C TUid | Uid() |
| IMPORT_C TInt | VerticalPixelsToTwips(TInt) |
| IMPORT_C TInt | VerticalTwipsToPixels(TInt) |
Detailed Description
BitGdi bitmap class (pseudo-CXxx class). WARNING: Class for internal use ONLY. Compatibility is not guaranteed in future releases.
Member Function Documentation
CheckBackgroundCompressData ( )
| IMPORT_C TInt | CheckBackgroundCompressData | ( | ) | |
Set a flag to indicate that this bitmap has to be compressed in the FBServer background thread
Returns: KErrNone if possible to compress, KErrAlreadyExists if already compressed
CompressData ( )
| IMPORT_C TInt | CompressData | ( | ) | |
Compress a bitmap if possible. If the bitmap is already compressed, or if compression yields no decrease in size, do nothing, but return success (KErrNone).
Returns: KErrNone if successful, otherwise a system wide error code.
CompressData ( TBitmapfileCompressionScheme )
Compress a bitmap if possible. If the bitmap is already compressed, or if compression yields no decrease in size, do nothing, but return success (KErrNone).
| Parameter | Description | | aScheme | The type of bitmap file compression. |
Returns: KErrNone if successful, otherwise a system wide error code.
DataStride ( )
| IMPORT_C TInt | DataStride | ( | ) | const |
ExternalizeL ( RWriteStream &, const CFbsBitmap & )
ExternalizeRectangleL ( RWriteStream &, const TRect &, const CFbsBitmap & )
GetPixel ( TRgb &, const TPoint &, TUint32 *, CFbsRasterizer * )
The method retrieves the red, green, blue (RGB) color value of the pixel with specified coordinates. Note: The method works for uncompressed bitmaps and extended bitmaps only.
- Pre-condition
- aBase != NULL;
| Parameter | Description | | aColor | It will be initialized with the pixel color value on success, otherwise aColor value will be left unchanged. |
| aPos | Pixel coordinates. |
| aBase | It points to the beginning of the bitmap data. |
GetScanLine ( TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *, TLineScanningPosition & )
GetScanLine ( TUint32 *&, TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode )
GetScanLine ( TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 * )
GetScanLinePtr ( TUint32 *&, TPoint &, TInt, TUint32 *, TLineScanningPosition & )
GetScanLinePtr ( TUint32 *&, TInt &, TPoint &, TUint32 *, TLineScanningPosition & )
GetVerticalScanLine ( TDes8 &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *, CFbsRasterizer * )
Gets the bitmap s vertical scanline starting at the specified x co-ordinate and using the specified dither offset. Note: The method works for uncompressed bitmaps only.
| Parameter | Description | | aBuf | The buffer in which the vertical scanline will be returned. |
| aX | The x co-ordinate of the vertical scanline to get. |
| aDitherOffset | The dither offset of the bitmap. |
| aDispMode | Format to be used to write the data to the buffer. |
| aBase | The bitmap's data start address. |
HardwareBitmapHandle ( )
| IMPORT_C TInt | HardwareBitmapHandle | ( | ) | const |
Header ( )
The header is exposed by CFbsBitmap so this doesn't break encapsulation. Specifically added to allow CBitmapObject to see compression information.
Returns: Address of iHeader.
HorizontalPixelsToTwips ( TInt )
| IMPORT_C TInt | HorizontalPixelsToTwips | ( | TInt | aPixels | ) | const |
HorizontalTwipsToPixels ( TInt )
| IMPORT_C TInt | HorizontalTwipsToPixels | ( | TInt | aTwips | ) | const |
InternalizeHeaderL ( RReadStream &, SEpocBitmapHeader & )
InternalizeL ( RReadStream & )
Internalizes the bit map contents from a stream.
| Parameter | Description | | aStream | The read stream containing the bit map. |
IsCompressed ( )
| IMPORT_C TBool | IsCompressed | ( | ) | const |
Check for a bitmap if it is compressed in some manner.
Returns: ETrue if successful Or EFalse if unsuccessful
IsCompressedInRAM ( )
| IMPORT_C TBool | IsCompressedInRAM | ( | ) | const |
IsLargeBitmap ( )
| IMPORT_C TBool | IsLargeBitmap | ( | ) | const |
IsMonochrome ( TUint32 * )
Tests whether or not the bitmap is monochrome. Monochrome bitmaps have a display-mode of 1 bit-per-pixel. Note: The method works for uncompressed bitmaps only.
| Parameter | Description | | aBase | Bitmap's data base address |
Returns: True if the bitmap is monochrome; false otherwise.
ScanLineAddress ( TUint32 *, TUint )
SetCompressionBookmark ( TLineScanningPosition &, TUint32 *, const CFbsBitmap * )
SizeInPixels ( )
| IMPORT_C TSize | SizeInPixels | ( | ) | const |
SizeInTwips ( )
| IMPORT_C TSize | SizeInTwips | ( | ) | const |
StretchScanLine ( TDes8 &, const TPoint &, TInt, TInt, TInt, TInt, TInt, const TPoint &, TDisplayMode, TUint32 * )
StretchScanLine ( TDes8 &, const TPoint &, TInt, TInt, TInt, TInt, TInt, const TPoint &, TDisplayMode, TUint32 *, TLineScanningPosition & )
| IMPORT_C void | StretchScanLine | ( | TDes8 & | aBuf, |
| | const TPoint & | aPixel, |
| | TInt | aClipStrchX, |
| | TInt | aClipStrchLen, |
| | TInt | aStretchLength, |
| | TInt | aOrgX, |
| | TInt | aOrgLen, |
| | const TPoint & | aDitherOffset, |
| | TDisplayMode | aDispMode, |
| | TUint32 * | aBase, |
| | TLineScanningPosition & | aLineScanningPosition |
| | ) | const |
VerticalPixelsToTwips ( TInt )
| IMPORT_C TInt | VerticalPixelsToTwips | ( | TInt | aPixels | ) | const |
VerticalTwipsToPixels ( TInt )
| IMPORT_C TInt | VerticalTwipsToPixels | ( | TInt | aTwips | ) | const |