#include <fbs.h>
| class TBitmapUtil |
| Public Member Functions | |
|---|---|
| TBitmapUtil(CFbsBitmap *) | |
| IMPORT_C void | Begin(const TPoint &) |
| IMPORT_C void | Begin(const TPoint &, const TBitmapUtil &) |
| IMPORT_C void | DecXPos() |
| IMPORT_C void | DecYPos() |
| IMPORT_C void | End() |
| IMPORT_C TUint32 | GetPixel() |
| IMPORT_C void | IncXPos() |
| IMPORT_C void | IncYPos() |
| IMPORT_C void | SetPixel(TUint32) |
| IMPORT_C void | SetPixel(const TBitmapUtil &) |
| IMPORT_C void | SetPos(const TPoint &) |
Provides fast read/write access to the pixel data of a bitmap.
Functionality includes getting and setting the individual pixels of a bitmap. Common to this is the concept of the current pixel position. This is held as member data and is changed by using various efficient functions. For example, incrementing the position's x- or y co-ordinate is much quicker than setting a completely new position. This efficiency issue is important as these functions are used as part of the frequently used blitting DDA used for creating stretched or compressed versions of bitmaps.
Calls to Begin() and End() must surround any calls to the other member functions. Note that you should always ensure each Begin() is matched by an End() call when using this class.
Note also that all display modes including EColor16M are supported, but the TDisplayMode values ERgb and ENone are not considered to be display modes.
| IMPORT_C | TBitmapUtil | ( | CFbsBitmap * | aBitmap | ) |
Constructs a TBitmapUtil object for the specified bitmap.
The use of extended or compressed bitmaps is not supported by TBitmapUtil.
| Parameter | Description |
|---|---|
| aBitmap | The bitmap on which this TBitmapUtil will operate. |
| IMPORT_C void | Begin | ( | const TPoint & | aPosition | ) |
Sets the current pixel position to the specified position and prepares the bitmap for access to its pixel data.
This function must be called before using any of the other functions provided by this class, otherwise damage to data may occur. It must also be matched by a subsequent call to End().
| Parameter | Description |
|---|---|
| aPosition | The position to which the current pixel position should be set. |
| IMPORT_C void | Begin | ( | const TPoint & | aPosition, |
| const TBitmapUtil & | aUtil | |||
| ) | ||||
Sets the current pixel position to the specified position and prepares the bitmap for access to its pixel data.
This function is deprecated. Use the other overload, Begin(const TPoint&). Deprecated
| Parameter | Description |
|---|---|
| aPosition | The position to which the current pixel position should be set. |
| aUtil | Not used. |
| IMPORT_C void | End | ( | ) |
Marks the end of the access to the bitmap data. This function must be called when finished using all the other functions provided by this class.
There must be exactly one call to End() for each previous call to Begin() for a given TBitmapUtil object.
| IMPORT_C TUint32 | GetPixel | ( | ) | const |
Gets the value of the pixel at the current pixel position.
In normal usage, the value returned will immediately be used as the parameter to a call to SetPixel(). To remove the overhead of constructing a TRgb, the function uses a TUint32 rather than a TRgb to hold an RGB value.
Returns: The value of the pixel at the current pixel position.
| IMPORT_C void | SetPixel | ( | TUint32 | aValue | ) |
Sets the value of the pixel at the current pixel position.
To remove the overhead of constructing a TRgb, the function uses a TUint32 rather than a TRgb to hold an RGB value.
| Parameter | Description |
|---|---|
| aValue | The value to which the pixel at the current pixel position is to be set. |
| IMPORT_C void | SetPixel | ( | const TBitmapUtil & | aSource | ) |
Sets the value of the pixel at the current pixel position to that returned by aSource.GetPixel().
| Parameter | Description |
|---|---|
| aSource | The TBitmapUtil of the source bitmap, whose pixel value is used to set the pixel at the current pixel position. |
| IMPORT_C void | SetPos | ( | const TPoint & | aPosition | ) |
Sets a new current pixel position.
| Parameter | Description |
|---|---|
| aPosition | The new current pixel position. |