Destructor. Calls Reset(). Reset()

Marks the beginning of direct access to the bitmap data. This function prepares the bitmap for direct access to its pixel data and should be used before calling DataAddress(), otherwise performance may be degraded on certain platforms. Calls to BeginDataAccess() must be coupled with subsequent calls to EndDataAccess().

CFbsBitmap::DataAddress() CFbsBitmap::EndDataAccess()

Compresses bitmap in RAM.

Submits the bitmap for asynchronous background compression.

Submits the bitmap for asynchronous background compression. No notification will be provided when the compression has completed.

Submits the bitmap for asynchronous background compression.

Submits the bitmap for asynchronous background compression. No notification will be provided when the compression has completed.

Creates a bitmap with the specified size and display mode. The bitmap is created on the font and bitmap server's shared heap.

Creates an extended bitmap. Extended bitmaps are used to store immutable data in a platform-specific format. They cannot be used as targets of graphics contexts, and modification of their data via DataAddress() or TBitmapUtil is not supported and results in undefined behaviour up to and including process termination.

Initialisation of the raw data of the new bitmap is carried out by copying the data pointed to by the parameter aData.

Read-only access to the raw data of an extended bitmap is provided by DataAddress() and DataSize() in conjunction with BeginDataAccess() and EndDataAccess().

Extended bitmaps have a conceptual size in pixels and a conceptual display mode for compatibility purposes. The raw data can be independent of these properties.

CFbsBitmap::DataAddress() CFbsBitmap::DataSize() CFbsBitmap::BeginDataAccess() CFbsBitmap::EndDataAccess()

Creates an extended bitmap. Extended bitmaps are used to store immutable data in a platform-specific format. They cannot be used as targets of graphics contexts, and modification of their data via DataAddress() or TBitmapUtil is not supported and results in undefined behaviour up to and including process termination.

Initialisation of the raw data of the new bitmap is carried out by a callback to the MFbsExtendedBitmapInitializer::InitExtendedBitmap() function passed through the parameter aInitializer.

Read-only access to the raw data of an extended bitmap is provided by DataAddress() and DataSize() in conjunction with BeginDataAccess() and EndDataAccess().

Extended bitmaps have a conceptual size in pixels and a conceptual display mode for compatibility purposes. The raw data can be independent of these properties.

CFbsBitmap::DataAddress() CFbsBitmap::DataSize() CFbsBitmap::BeginDataAccess() CFbsBitmap::EndDataAccess() MFbsExtendedBitmapInitializer

Creates a hardware bitmap with a size and display mode.

Gets the address of the first pixel in the bitmap. The first pixel is at the top-left. Access to the pixel data of a bitmap should be surrounded by calls to BeginDataAccess() and EndDataAccess(), otherwise performance may be degraded on certain platforms.

Note: Performing a Resize() or Compress() operation changes the value returned by this function. CFbsBitmap::BeginDataAccess() CFbsBitmap::EndDataAccess()

Gets the size in bytes of the bitmap data.

Gets the length in bytes between scanlines in memory.

Gets the display mode of the bitmap.

This method loads a bitmap from an opened file handle.

This method loads a bitmap from the mbm or rsc file specified by the filename.

This method tries to load a bitmap if mbm or rsc file is in ROM.

Duplicates a bitmap. This function does not create a copy of the bitmap. It just assigns another handle to the bitmap in the font and bitmap server, and sets this object's handle to that. If the specified bitmap is in the ROM, it just assigns a pointer to it. CFbsBitmap::Handle()

Marks the end of direct access to the bitmap data. Use this function after ending direct access to the bitmap data. Calls to EndDataAccess() must correspond to prior calls to BeginDataAccess(). See BeginDataAccess() for more details.

CFbsBitmap::BeginDataAccess()

Gets the UID identifying the data format of an extended bitmap.

Externalises the bitmap to the specified stream. Not supported for extended bitmaps.

Externalises that area of the bitmap contained within a specified rectangular area. Not supported for extended bitmaps.

Gets a pointer to the decompression buffer owned by this thread's FBServ session.

Gets a pointer to an extra buffer for general use owned by this thread's FBServ session.

Gets the bitmap's palette. This is not currently supported.

Gets the bitmap's scanline for the specified line starting from the specified point. The dither offset of the bitmap is taken to be TPoint(0,0).

Gets the bitmap's scanline for the specified line starting from the specified point and using the specified dither offset.

Gets the handle number of the bitmap. The returned value can be used to give another thread access to the bitmap. CFbsBitmap::Duplicate()

Returns the handle for the hardware bitmap which this CFbsBitmap is using.

Creates a bitmap header. This is used when streaming bitmaps to stores.

Converts a horizontal dimension on the graphics device from pixels to twips.

Converts a horizontal dimension on the graphics device from twips to pixels.

Returns the display mode that was used to create the bitmap.

Internalises a CFbsBitmap from a stream.

Tests whether the bitmap located in RAM has been compressed.

Tests whether or not the specified file is in ROM.

Tests whether or not the specified file is in ROM.

Tests whether the bitmap is large.

Tests whether or not the bitmap is monochrome. Monochrome bitmaps have a display-mode of 1 bit-per-pixel.

Tests whether or not the bitmap is read-only.

Tests whether the bitmap is volatile. A bitmap becomes volatile if CFbsBitmap::DataAdress() is called without CFbsBitmap::BeginDataAccess() having been called before and it can become non-volatile again if a resizing or compression is performed.

Loads a specific bitmap from a multi-bitmap file. The bitmap may be shared by other font and bitmap server clients.

Loads a specific bitmap from a multi-bitmap file. The bitmap may be shared by other font and bitmap server clients.

Loads a specific bitmap from an opened multi-bitmap file handle. The bitmap may be shared by other font and bitmap server clients.

Loads a specific bitmap from an opened multi-bitmap file handle. The bitmap may be shared by other font and bitmap server clients.

Loads and compresses a specific bitmap from a multi-bitmap file. The bitmap may be shared by other font and bitmap server clients. If the bitmap is loaded from ROM then compression is not allowed.

Loads and compresses a specific bitmap from a multi-bitmap file. The bitmap may be shared by other font and bitmap server clients. If the bitmap is loaded from ROM then compression is not allowed.

Loads and compresses a specific bitmap from an opened multi-bitmap file handle. The bitmap may be shared by other font and bitmap server clients. If the bitmap is loaded from ROM then compression is not allowed.

Loads and compresses a specific bitmap from an opened multi-bitmap file handle. The bitmap may be shared by other font and bitmap server clients. If the bitmap is loaded from ROM then compression is not allowed.

This method handles very special case when the rsc file is in RAM, but it contains ROM mbm file. ROM mbm file format is different than RAM mbm file format and ROM mbm file cannot be loaded into RAM using standard techniques (used by CFbsBitmap::DoLoad()). We have to check it is really a ROM mbm file. If it is - we have to allocate the right amount of RAM, read and copy requested ROM bitmap to the allocated RAM.

Locks the global bitmap heap. This function is deprecated, since it is no longer necessary to lock the global bitmap heap to prevent the pixel data from being moved in memory asynchronously, as the value returned by DataAddress() can now only change as a result of bitmap operations explicitly requested by clients of the Font and Bitmap Server. Calls to LockHeap() should be replaced by calls to BeginDataAccess().

Locks the global bitmap heap, leaving on the clean-up stack a pointer to a TCleanupItem that unlocks the heap on deletion. Use this function instead of LockHeap() if code may leave between the LockHeap() - UnlockHeap() pair. Calls to LockHeapLC() must be coupled with subsequent calls to CFbsBitmap::UnlockHeap() or CleanupStack::PopAndDestroy(). This function is deprecated. See CFbsBitmap::LockHeap() for more details.

CFbsBitmap::LockHeap()

Gets the attributes of the bitmap's palette. This is not currently supported.

Gets a pointer to the rasterizer for extended bitmaps if present.

Releases the bitmap's handle from the font and bitmap server and decrements its access count. The server-side bitmap is only deleted when the access count for the bitmap decrements to zero.

Resets the pixel-size of the bitmap. If the new size is bigger than the old, the original bitmap is still situated at (0,0), but pixels outside the range of the old pixel-size are set to zero.

Saves the bitmap as a direct file store. The file store overwrites any existing file with the same name.

Saves the bitmap as a direct file store using an opened file handle. The file store overwrites any existing file with the same name.

Gets the physical length in bytes of a scanline in memory. This is aligned to a 4 byte (DWORD) boundary for performance reasons.

Returns the serial number of the bitmap The serial number is unique to this bitmap. The serial number is a signed 64-bit integer, with only the positive values being assigned. As ROM bitmaps do not have serial numbers, the serial number will use the negative range of values so that ROM bitmap's serial number cannot be the same as a RAM bitmap's. ROM bitmap's address pointers are unique to the ROM bitmap, so the serial number will just be negative value of the address pointer.

Changes the display mode of the bitmap. The requested display mode cannot be greater (in bpp value) than the initial display mode. This method cannot leave, for instance because of an out of memory condition. No additional memory is allocated or leaving methods called. The bitmap's content is preserved when converting it to the requested display mode, but there may be some loss of quality. CFbsBitmap::InitialDisplayMode()

Sets the bitmap's palette. This is not currently supported.

Sets the twip-size of the bitmap by converting the bitmaps pixel-size from pixels to twips, using the conversion functions in the specified graphics device map.

Sets the twip-size of the bitmap directly to the specified size.

Gets the pixel-size of the bitmap.

Gets the twip-size of the bitmap.

Constructs a multi-bitmap file.

Constructs a multi-bitmap file using an opened file handle.

Swaps the bitmap's width and height. For example, if the bitmap's size is (40, 20), the new size will be (20, 40). Bitmap content is not preserved.

Tests how many times the bitmap has been touched. A bitmap is touched whenever CFbsBitmap::EndDataAccess() is called with the parameter aReadOnly set to EFalse and also whenever a resizing or compression is performed.

Unlocks the global heap. This function is deprecated. See LockHeap() for more details. Calls to UnlockHeap() should be replaced by calls to EndDataAccess(). Calls to UnlockHeap() must correspond to prior calls to LockHeap() or LockHeapLC().

CFbsBitmap::LockHeap() CFbsBitmap::EndDataAccess()

Converts a vertical dimension on the graphics device from pixels to twips.

Converts a vertical dimension on the graphics device from twips to pixels.

WARNING: For internal use ONLY. Compatibility is not guaranteed in future releases.

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.