CWsBitmap Class Reference

class CWsBitmap : public CFbsBitmap

Window server bitmap.

This is a bitmap to which the window server already has a handle. Functions which take a window server bitmap are faster than equivalent functions which take a CFbsBitmap .

Inherits from

Public Member Functions
CWsBitmap ()
CWsBitmap ( RWsSession &)
~CWsBitmap ()
IMPORT_C TInt Create (const TSize &, TDisplayMode )
IMPORT_C TInt Duplicate ( TInt )
IMPORT_C void InternalizeL ( RReadStream &)
IMPORT_C TInt Load (const TDesC &, TInt32 , TBool )
IMPORT_C void Reset ()
Private Member Functions
TInt createWsBitmap ( 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()
CFbsBitmap::Address()const
CFbsBitmap::BeginDataAccess()const
CFbsBitmap::BeginDataAccessAndGetCleanAddress(TUint32 *&)const
CFbsBitmap::CFbsBitmap()
CFbsBitmap::CleanAddress()const
CFbsBitmap::Compress()
CFbsBitmap::Compress(TBitmapfileCompressionScheme)
CFbsBitmap::CompressInBackground()
CFbsBitmap::CompressInBackground(TBitmapfileCompressionScheme)
CFbsBitmap::CompressInBackground(TRequestStatus &)
CFbsBitmap::CompressInBackground(TRequestStatus &,TBitmapfileCompressionScheme)
CFbsBitmap::CreateExtendedBitmap(const TSize &,TDisplayMode,TUid,TInt,MFbsExtendedBitmapInitializer &)
CFbsBitmap::CreateExtendedBitmap(const TSize &,TDisplayMode,TUid,const TAny *,TInt)
CFbsBitmap::CreateHardwareBitmap(const TSize &,TDisplayMode,TUid)
CFbsBitmap::DataAddress()const
CFbsBitmap::DataSize()const
CFbsBitmap::DataStride()const
CFbsBitmap::DisplayMode()const
CFbsBitmap::DoCreate(const TSize &,TDisplayMode,TUid,TInt)
CFbsBitmap::DoSaveL(RFile &)
CFbsBitmap::EndDataAccess(TBool)const
CFbsBitmap::ExtendedBitmapType()const
CFbsBitmap::ExternalizeL(RWriteStream &)const
CFbsBitmap::ExternalizeRectangleL(RWriteStream &,const TRect &)const
CFbsBitmap::GetAllBitmapHandles(RArray< TInt > &)const
CFbsBitmap::GetDecompressionBuffer(TInt)
CFbsBitmap::GetExtraBuffer(TInt)
CFbsBitmap::GetPalette(CPalette *&)const
CFbsBitmap::GetPixel(TRgb &,const TPoint &)const
CFbsBitmap::GetScanLine(TDes8 &,const TPoint &,TInt,TDisplayMode)const
CFbsBitmap::GetScanLine(TDes8 &,const TPoint &,TInt,const TPoint &,TDisplayMode)const
CFbsBitmap::GetVerticalScanLine(TDes8 &,TInt,TDisplayMode)const
CFbsBitmap::GetVerticalScanLine(TDes8 &,TInt,const TPoint &,TDisplayMode)const
CFbsBitmap::Handle()const
CFbsBitmap::HardwareBitmapHandle()const
CFbsBitmap::Header()const
CFbsBitmap::HorizontalPixelsToTwips(TInt)const
CFbsBitmap::HorizontalTwipsToPixels(TInt)const
CFbsBitmap::InitialDisplayMode()const
CFbsBitmap::IsCompressedInRAM()const
CFbsBitmap::IsFileInRom(RFile &,TUint32 *&)
CFbsBitmap::IsFileInRom(const TDesC &,TUint32 *&)
CFbsBitmap::IsLargeBitmap()const
CFbsBitmap::IsMonochrome()const
CFbsBitmap::IsRomBitmap()const
CFbsBitmap::IsVolatile()const
CFbsBitmap::Load(RFile &,TInt32,TBool)
CFbsBitmap::Load(RFile &,TInt32,TBool,TUint)
CFbsBitmap::Load(const TDesC &,TInt32,TBool,TUint)
CFbsBitmap::LoadAndCompress(RFile &,TInt32,TBool)
CFbsBitmap::LoadAndCompress(RFile &,TInt32,TBool,TUint)
CFbsBitmap::LoadAndCompress(const TDesC &,TInt32,TBool)
CFbsBitmap::LoadAndCompress(const TDesC &,TInt32,TBool,TUint)
CFbsBitmap::LockHeap(TBool)const
CFbsBitmap::LockHeapLC(TBool)const
CFbsBitmap::PaletteAttributes(TBool &,TInt &)const
CFbsBitmap::Rasterizer()
CFbsBitmap::Resize(const TSize &)
CFbsBitmap::Save(RFile &)
CFbsBitmap::Save(const TDesC &)
CFbsBitmap::ScanLineLength(TInt,TDisplayMode)
CFbsBitmap::SerialNumber()const
CFbsBitmap::SetDisplayMode(TDisplayMode)
CFbsBitmap::SetPalette(CPalette *)
CFbsBitmap::SetRomBitmapL(CBitwiseBitmap *,TInt &)
CFbsBitmap::SetScanLine(TDes8 &,TInt)const
CFbsBitmap::SetSizeInTwips(const MGraphicsDeviceMap *)
CFbsBitmap::SetSizeInTwips(const TSize &)
CFbsBitmap::SizeInPixels()const
CFbsBitmap::SizeInTwips()const
CFbsBitmap::StoreL(RFile &,TInt,const TDesC *,TInt32)
CFbsBitmap::StoreL(const TDesC &,TInt,const TDesC *,TInt32)
CFbsBitmap::SwapWidthAndHeight()
CFbsBitmap::TouchCount()const
CFbsBitmap::UnlockHeap(TAny *)
CFbsBitmap::UnlockHeap(TBool)const
CFbsBitmap::VerticalPixelsToTwips(TInt)const
CFbsBitmap::VerticalTwipsToPixels(TInt)const
CFbsBitmap::~CFbsBitmap()
Inherited Enumerations
CFbsBitmap:@60
Inherited Attributes
CFbsBitmap::iAddressPointer
CFbsBitmap::iFbs
CFbsBitmap::iFlags
CFbsBitmap::iHandle
CFbsBitmap::iServerHandle
CFbsBitmap::iUseCount

Constructor & Destructor Documentation

CWsBitmap()

IMPORT_C CWsBitmap ( )

Default constructor. Developers should use the other constructor overload.

CWsBitmap(RWsSession &)

IMPORT_C CWsBitmap ( RWsSession & aWs )

Constructor which takes a window server session as an argument.

Parameters

RWsSession & aWs Handle to window server session.

~CWsBitmap()

IMPORT_C ~CWsBitmap ( )

Destructor.

Member Functions Documentation

Create(const TSize &, TDisplayMode)

IMPORT_C TInt Create ( const TSize & aSizeInPixels,
TDisplayMode aDispMode
)

Creates a bitmap, specifying the size and display mode.

This function, if successful, always causes a flush of the window server buffer.

CFbsBitmap::Create()

Parameters

const TSize & aSizeInPixels The size of the bitmap to be created.
TDisplayMode aDispMode The display-mode of the bitmap to be created.

Duplicate(TInt)

IMPORT_C TInt Duplicate ( TInt aHandle )

Makes this bitmap a duplicate of the specified bitmap.

This function, if successful, always causes a flush of the window server buffer.

CFbsBitmap::Duplicate()

Parameters

TInt aHandle The handle of the bitmap to be duplicated.

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream )

Internalises a CWsBitmap from the read stream.

The presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.

This function always causes a flush of the window server buffer.

Parameters

RReadStream & aStream The stream from which to internalise the bitmap.

Load(const TDesC &, TInt32, TBool)

IMPORT_C TInt Load ( const TDesC & aFileName,
TInt32 aId,
TBool aShareIfLoaded = ETrue
)

Loads a bitmap from a file.

If aShareIfLoaded is ETrue the bitmap will be allowed to be shared by a number of font and bitmap server clients.

This function, if successful, always causes a flush of the window server buffer.

CFbsBitmap::Load()

Parameters

const TDesC & aFileName The filename of the multibitmap (.mbm) file containing the bitmap to be loaded.
TInt32 aId The identifier of the bitmap in the .mbm file which should be loaded.
TBool aShareIfLoaded = ETrue Specifies whether or not the loaded bitmap will be made available for sharing between font and bitmap server clients.

Reset()

IMPORT_C void Reset ( )

Releases the bitmap's handle from the font and bitmap server.

The function also decrements the bitmap's access count in the font and bitmap server. The server-side bitmap is deleted only if the access count for the bitmap decrements to zero.

createWsBitmap(TInt)

TInt createWsBitmap ( TInt aErr ) [private]

Parameters

TInt aErr