CBitwiseBitmap Class Reference

#include <bitmap.h>

Link against: fbscli.lib

class CBitwiseBitmap
Public Member Functions
IMPORT_C TIntCheckBackgroundCompressData()
IMPORT_C TIntCompressData()
IMPORT_C TIntCompressData(TBitmapfileCompressionScheme)
IMPORT_C TIntDataStride()
IMPORT_C TDisplayModeDisplayMode()
IMPORT_C voidExternalizeL(RWriteStream &, const CFbsBitmap &)
IMPORT_C voidExternalizeRectangleL(RWriteStream &, const TRect &, const CFbsBitmap &)
IMPORT_C voidGetPixel(TRgb &, const TPoint &, TUint32 *, CFbsRasterizer *)
IMPORT_C voidGetScanLine(TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *, TLineScanningPosition &)
IMPORT_C voidGetScanLine(TUint32 *&, TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode)
IMPORT_C voidGetScanLine(TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *)
IMPORT_C TIntGetScanLinePtr(TUint32 *&, TPoint &, TInt, TUint32 *, TLineScanningPosition &)
IMPORT_C TIntGetScanLinePtr(TUint32 *&, TInt &, TPoint &, TUint32 *, TLineScanningPosition &)
IMPORT_C voidGetVerticalScanLine(TDes8 &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *, CFbsRasterizer *)
IMPORT_C TIntHardwareBitmapHandle()
IMPORT_C SEpocBitmapHeaderHeader()
IMPORT_C TIntHorizontalPixelsToTwips(TInt)
IMPORT_C TIntHorizontalTwipsToPixels(TInt)
IMPORT_C voidInternalizeHeaderL(RReadStream &, SEpocBitmapHeader &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TBoolIsCompressed()
IMPORT_C TBoolIsCompressedInRAM()
IMPORT_C TBoolIsLargeBitmap()
IMPORT_C TBoolIsMonochrome(TUint32 *)
IMPORT_C TUint32 *ScanLineAddress(TUint32 *, TUint)
IMPORT_C voidSetCompressionBookmark(TLineScanningPosition &, TUint32 *, const CFbsBitmap *)
IMPORT_C TSizeSizeInPixels()
IMPORT_C TSizeSizeInTwips()
IMPORT_C voidStretchScanLine(TDes8 &, const TPoint &, TInt, TInt, TInt, TInt, TInt, const TPoint &, TDisplayMode, TUint32 *)
IMPORT_C voidStretchScanLine(TDes8 &, const TPoint &, TInt, TInt, TInt, TInt, TInt, const TPoint &, TDisplayMode, TUint32 *, TLineScanningPosition &)
IMPORT_C TUidUid()
IMPORT_C TIntVerticalPixelsToTwips(TInt)
IMPORT_C TIntVerticalTwipsToPixels(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 TIntCheckBackgroundCompressData()

Set a flag to indicate that this bitmap has to be compressed in the FBServer background thread

Return Value
KErrNone if possible to compress, KErrAlreadyExists if already compressed

CompressData ( )

IMPORT_C TIntCompressData()

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

Return Value
KErrNone if successful, otherwise a system wide error code.

CompressData ( TBitmapfileCompressionScheme )

IMPORT_C TIntCompressData(TBitmapfileCompressionSchemeaScheme)

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

Parameters
aSchemeThe type of bitmap file compression.
Return Value
KErrNone if successful, otherwise a system wide error code.

DataStride ( )

IMPORT_C TIntDataStride()const

DisplayMode ( )

IMPORT_C TDisplayModeDisplayMode()const

ExternalizeL ( RWriteStream &, const CFbsBitmap & )

IMPORT_C voidExternalizeL(RWriteStream &aStream,
const CFbsBitmap &aHandleBitmap
)const

ExternalizeRectangleL ( RWriteStream &, const TRect &, const CFbsBitmap & )

IMPORT_C voidExternalizeRectangleL(RWriteStream &aStream,
const TRect &aRect,
const CFbsBitmap &aHandleBitmap
)const

GetPixel ( TRgb &, const TPoint &, TUint32 *, CFbsRasterizer * )

IMPORT_C voidGetPixel(TRgb &aColor,
const TPoint &aPos,
TUint32 *aBase,
CFbsRasterizer *aRasterizer
)const
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;
Parameters
aColorIt will be initialized with the pixel color value on success, otherwise aColor value will be left unchanged.
aPosPixel coordinates.
aBaseIt points to the beginning of the bitmap data.

GetScanLine ( TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *, TLineScanningPosition & )

IMPORT_C voidGetScanLine(TDes8 &aBuf,
const TPoint &aPixel,
TIntaLength,
TBoolaDither,
const TPoint &aDitherOffset,
TDisplayModeaDispMode,
TUint32 *aBase,
TLineScanningPosition &aLineScanningPosition
)const

GetScanLine ( TUint32 *&, TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode )

IMPORT_C voidGetScanLine(TUint32 *&aSlptr,
TDes8 &aBuf,
const TPoint &aPixel,
TIntaLength,
TBoolaDither,
const TPoint &aDitherOffset,
TDisplayModeaDispMode
)const

GetScanLine ( TDes8 &, const TPoint &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 * )

IMPORT_C voidGetScanLine(TDes8 &aBuf,
const TPoint &aPixel,
TIntaLength,
TBoolaDither,
const TPoint &aDitherOffset,
TDisplayModeaDispMode,
TUint32 *aBase
)const

GetScanLinePtr ( TUint32 *&, TPoint &, TInt, TUint32 *, TLineScanningPosition & )

IMPORT_C TIntGetScanLinePtr(TUint32 *&aSlptr,
TPoint &aPixel,
TIntaLength,
TUint32 *aBase,
TLineScanningPosition &aLineScanningPosition
)const

GetScanLinePtr ( TUint32 *&, TInt &, TPoint &, TUint32 *, TLineScanningPosition & )

IMPORT_C TIntGetScanLinePtr(TUint32 *&aSlptr,
TInt &aLength,
TPoint &aPixel,
TUint32 *aBase,
TLineScanningPosition &aLineScanningPosition
)const

GetVerticalScanLine ( TDes8 &, TInt, TBool, const TPoint &, TDisplayMode, TUint32 *, CFbsRasterizer * )

IMPORT_C voidGetVerticalScanLine(TDes8 &aBuf,
TIntaX,
TBoolaDither,
const TPoint &aDitherOffset,
TDisplayModeaDispMode,
TUint32 *aBase,
CFbsRasterizer *aRasterizer
)const

Gets the bitmaps vertical scanline starting at the specified x co-ordinate and using the specified dither offset. Note: The method works for uncompressed bitmaps only.

Parameters
aBufThe buffer in which the vertical scanline will be returned.
aXThe x co-ordinate of the vertical scanline to get.
aDitherOffsetThe dither offset of the bitmap.
aDispModeFormat to be used to write the data to the buffer.
aBaseThe bitmap's data start address.

HardwareBitmapHandle ( )

IMPORT_C TIntHardwareBitmapHandle()const

Header ( )

IMPORT_C SEpocBitmapHeaderHeader()const

The header is exposed by CFbsBitmap so this doesn't break encapsulation. Specifically added to allow CBitmapObject to see compression information.

Return Value
Address of iHeader.

HorizontalPixelsToTwips ( TInt )

IMPORT_C TIntHorizontalPixelsToTwips(TIntaPixels)const

HorizontalTwipsToPixels ( TInt )

IMPORT_C TIntHorizontalTwipsToPixels(TIntaTwips)const

InternalizeHeaderL ( RReadStream &, SEpocBitmapHeader & )

IMPORT_C voidInternalizeHeaderL(RReadStream &aStream,
SEpocBitmapHeader &aHeader
)[static]

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalizes the bit map contents from a stream.

Parameters
aStreamThe read stream containing the bit map.

IsCompressed ( )

IMPORT_C TBoolIsCompressed()const

Check for a bitmap if it is compressed in some manner.

Return Value
ETrue if successful Or EFalse if unsuccessful

IsCompressedInRAM ( )

IMPORT_C TBoolIsCompressedInRAM()const

IsLargeBitmap ( )

IMPORT_C TBoolIsLargeBitmap()const

IsMonochrome ( TUint32 * )

IMPORT_C TBoolIsMonochrome(TUint32 *aBase)const

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.

Parameters
aBaseBitmap's data base address
Return Value
True if the bitmap is monochrome; false otherwise.

ScanLineAddress ( TUint32 *, TUint )

IMPORT_C TUint32 *ScanLineAddress(TUint32 *aBase,
TUintaY
)const

SetCompressionBookmark ( TLineScanningPosition &, TUint32 *, const CFbsBitmap * )

IMPORT_C voidSetCompressionBookmark(TLineScanningPosition &aLineScanningPosition,
TUint32 *aBase,
const CFbsBitmap *aFbsBitmap
)

SizeInPixels ( )

IMPORT_C TSizeSizeInPixels()const

SizeInTwips ( )

IMPORT_C TSizeSizeInTwips()const

StretchScanLine ( TDes8 &, const TPoint &, TInt, TInt, TInt, TInt, TInt, const TPoint &, TDisplayMode, TUint32 * )

IMPORT_C voidStretchScanLine(TDes8 &aBuf,
const TPoint &aPixel,
TIntaClipStrchX,
TIntaClipStrchLen,
TIntaStretchLength,
TIntaOrgX,
TIntaOrgLen,
const TPoint &aDitherOffset,
TDisplayModeaDispMode,
TUint32 *aBase
)const

StretchScanLine ( TDes8 &, const TPoint &, TInt, TInt, TInt, TInt, TInt, const TPoint &, TDisplayMode, TUint32 *, TLineScanningPosition & )

IMPORT_C voidStretchScanLine(TDes8 &aBuf,
const TPoint &aPixel,
TIntaClipStrchX,
TIntaClipStrchLen,
TIntaStretchLength,
TIntaOrgX,
TIntaOrgLen,
const TPoint &aDitherOffset,
TDisplayModeaDispMode,
TUint32 *aBase,
TLineScanningPosition &aLineScanningPosition
)const

Uid ( )

IMPORT_C TUidUid()const

VerticalPixelsToTwips ( TInt )

IMPORT_C TIntVerticalPixelsToTwips(TIntaPixels)const

VerticalTwipsToPixels ( TInt )

IMPORT_C TIntVerticalTwipsToPixels(TIntaTwips)const