|
|
|
class CWsBitmap : public CFbsBitmap, public MWsClientClass;
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.
MWsClientClass - Base class for all classes whose objects are clients of the window server.
CBase -
Base class for all classes to be instantiated on the heap.
CFbsBitmap - Note that this class is not intended for user derivation. A bitmap managed by th...
CWsBitmap - Window server bitmap.
Defined in CWsBitmap:
CWsBitmap()Default constructor. Developers should use the other constructor overload. CWsBitmap(RWsSession &)Constructor which takes a window server session as an argument.Create(const TSize &,TDisplayMode)Creates a bitmap, specifying the size and display mode.Duplicate(TInt)Makes this bitmap a duplicate of the specified bitmap.InternalizeL(RReadStream &)Internalises a CWsBitmap from the read stream.Load(const TDesC &,TInt32,TBool)Loads a bitmap from a file.Reset()Releases the bitmap's handle from the font and bitmap server.~CWsBitmap()Destructor. Inherited from CBase:
Delete(CBase *)Deletes the specified object.Extension_(TUint,TAny *&,TAny *)Extension function operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TAny *)Initialises the object to binary zeroes.operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...Inherited from CFbsBitmap:
BeginDataAccess()constMarks the beginning of direct access to the bitmap data. This function prepares ...CleanAddress()constCleanAddress(TUint32 *&)constCompress()Compress(TBitmapfileCompressionScheme)Compresses bitmap in RAM. CompressInBackground()Submits the bitmap for asynchronous background compression. No notification will...CompressInBackground(TBitmapfileCompressionScheme)Submits the bitmap for asynchronous background compression. No notification will...CompressInBackground(TRequestStatus &)Submits the bitmap for asynchronous background compression. CompressInBackground(TRequestStatus &,TBitmapfileCompressionScheme)Submits the bitmap for asynchronous background compression. CreateHardwareBitmap(const TSize &,TDisplayMode,TUid)Creates a hardware bitmap with a size and display mode. DataAddress()constGets the address of the first pixel in the bitmap. The first pixel is at the top...DisplayMode()constGets the display mode of the bitmap. EndDataAccess(TBool)constMarks the end of direct access to the bitmap data. Use this function after endin...ExternalizeL(RWriteStream &)constExternalises the bitmap to the specified stream. ExternalizeRectangleL(RWriteStream &,const TRect &)constExternalises that area of the bitmap contained within a specified rectangular ar...GetPalette(CPalette *&)constGets the bitmap's palette. This is not currently supported. GetPixel(TRgb &,const TPoint &)constGets the RGB value of the specified pixel. GetScanLine(TDes8 &,const TPoint &,TInt,TDisplayMode)constGets the bitmap's scanline for the specified line starting from the specified po...GetScanLine(TDes8 &,const TPoint &,TInt,const TPoint &,TDisplayMode)constGets the bitmap's scanline for the specified line starting from the specified po...GetVerticalScanLine(TDes8 &,TInt,TDisplayMode)constGets the bitmap's vertical scanline starting at the specified x co-ordinate. Not...GetVerticalScanLine(TDes8 &,TInt,const TPoint &,TDisplayMode)constGets the bitmap's vertical scanline starting at the specified x co-ordinate and ...Handle()constGets the handle number of the bitmap. The returned value can be used to give ano...HardwareBitmapHandle()constReturns the handle for the hardware bitmap which this CFbsBitmap is using. Header()constCreates a bitmap header. This is used when streaming bitmaps to stores. HorizontalPixelsToTwips(TInt)constConverts a horizontal dimension on the graphics device from pixels to twips. HorizontalTwipsToPixels(TInt)constConverts a horizontal dimension on the graphics device from twips to pixels. InitialDisplayMode()constReturns the display mode that was used to create the bitmap. IsCompressedInRAM()constTests whether the bitmap located in RAM has been compressed. IsFileInRom(RFile &,TUint32 *&)Tests whether or not the specified file is in ROM. IsFileInRom(const TDesC &,TUint32 *&)Tests whether or not the specified file is in ROM. IsLargeBitmap()constTests whether the bitmap is large. A bitmap is defined to be large if its size i...IsMonochrome()constTests whether or not the bitmap is monochrome. Monochrome bitmaps have a display...IsRomBitmap()constTests whether or not the bitmap is in ROM. Load(RFile &,TInt32,TBool)Loads a specific bitmap from an opened multi-bitmap file handle. The bitmap may ...Load(RFile &,TInt32,TBool,TUint)Loads a specific bitmap from an opened multi-bitmap file handle. The bitmap may ...Load(const TDesC &,TInt32,TBool,TUint)Loads a specific bitmap from a multi-bitmap file. The bitmap may be shared by ot...LoadAndCompress(RFile &,TInt32,TBool)Loads and compresses a specific bitmap from an opened multi-bitmap file handle. ...LoadAndCompress(RFile &,TInt32,TBool,TUint)Loads and compresses a specific bitmap from an opened multi-bitmap file handle. ...LoadAndCompress(const TDesC &,TInt32,TBool)Loads and compresses a specific bitmap from a multi-bitmap file. The bitmap may ...LoadAndCompress(const TDesC &,TInt32,TBool,TUint)Loads and compresses a specific bitmap from a multi-bitmap file. The bitmap may ...LockHeap(TBool)constLocks the global bitmap heap. This function is deprecated, since it is no longer...LockHeapLC(TBool)constLocks the global bitmap heap, leaving on the clean-up stack a pointer to a TClea...PaletteAttributes(TBool &,TInt &)constGets the attributes of the bitmap's palette. This is not currently supported. Resize(const TSize &)Resets the pixel-size of the bitmap. If the new size is bigger than the old, the...Save(RFile &)Saves the bitmap as a direct file store using an opened file handle. The file st...Save(const TDesC &)Saves the bitmap as a direct file store. The file store overwrites any existing ...ScanLineLength(TInt,TDisplayMode)Gets the physical length in bytes of a scanline in memory. This is aligned to a ...SetDisplayMode(TDisplayMode)Changes the display mode of the bitmap. The requested display mode cannot be gre...SetPalette(CPalette *)Sets the bitmap's palette. This is not currently supported. SetRomBitmapL(CBitwiseBitmap *,TInt &)Sets the bitmap to use a bitmap image stored in ROM. SetScanLine(TDes8 &,TInt)constSets the bitmap's horizontal scanline at the specified y co-ordinate to the scan...SetSizeInTwips(const MGraphicsDeviceMap *)Sets the twip-size of the bitmap by converting the bitmaps pixel-size from pixel...SetSizeInTwips(const TSize &)Sets the twip-size of the bitmap directly to the specified size. SizeInPixels()constGets the pixel-size of the bitmap. SizeInTwips()constGets the twip-size of the bitmap. StoreL(RFile &,TInt,const TDesC *,TInt32)Constructs a multi-bitmap file using an opened file handle. StoreL(const TDesC &,TInt,const TDesC *,TInt32)Constructs a multi-bitmap file. SwapWidthAndHeight()Swaps the bitmap's width and height. For example, if the bitmap's size is (40, 2...UnlockHeap(TAny *)UnlockHeap(TBool)constUnlocks the global heap. This function is deprecated. See CFbsBitmap::LockHeap(T...VerticalPixelsToTwips(TInt)constConverts a vertical dimension on the graphics device from pixels to twips. VerticalTwipsToPixels(TInt)constConverts a vertical dimension on the graphics device from twips to pixels. Inherited from MWsClientClass:
WsHandle()constGets the server side handle for the object.IMPORT_C CWsBitmap();
Default constructor. Developers should use the other constructor overload.
IMPORT_C CWsBitmap(RWsSession &aWs);
Constructor which takes a window server session as an argument.
|
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(const TSize &,TDisplayMode)Creates a bitmap with the specified size and display mode. The bitmap is created...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(TInt)Duplicates a bitmap. This function does not create a copy of the bitmap. It just...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(const TDesC &,TInt32,TBool)Loads a specific bitmap from a multi-bitmap file. The bitmap may be shared by ot...IMPORT_C void InternalizeL(RReadStream &aStream);
Internalises a CWsBitmap from the read stream.
The presence of this function means that the standard templated operator>>(RReadStream &,T &) can be used to internalise objects of this class.
This function always causes a flush of the window server buffer.
|
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.