Skip to main content
Version: 4.16

BitmapData

Data of a bitmap.

Public Functions#

BitmapFormatgetFormat() const
Gets the Bitmap format by combining the high and low parts (format_hi << 3)

Public Attributes#

const uint8_t *constdata
The data of this Bitmap.
const uint8_t *constextraData
The data of either the alpha channel (if present) or clut data in case of indexed color bitmap. 0 if not used.
const uint16_tformat_hi
Determine the format of the data (high 3 bits)
const uint16_tformat_lo
Determine the format of the data (low 3 bits)
const uint16_theight
The height of the Bitmap.
const uint16_tsolidRect_height
The height of the maximum solid rectangle of the Bitmap.
const uint16_tsolidRect_width
The width of the maximum solid rectangle of the Bitmap.
const uint16_tsolidRect_x
The x coordinate of the maximum solid rectangle of the Bitmap.
const uint16_tsolidRect_y
The y coordinate of the maximum solid rectangle of the Bitmap.
const uint16_twidth
The width of the Bitmap.

Public Functions Documentation#

getFormat#

BitmapFormat getFormat()const

Gets the Bitmap format by combining the high and low parts (format_hi << 3) | format_lo.

Returns:

The BitmapFormat

Public Attributes Documentation#

data#

const uint8_t *const data

The data of this Bitmap.

extraData#

const uint8_t *const extraData

The data of either the alpha channel (if present) or clut data in case of indexed color bitmap. 0 if not used.

format_hi#

const uint16_t format_hi

Determine the format of the data (high 3 bits)

format_lo#

const uint16_t format_lo

Determine the format of the data (low 3 bits)

height#

const uint16_t height

The height of the Bitmap.

solidRect_height#

const uint16_t solidRect_height

The height of the maximum solid rectangle of the Bitmap.

solidRect_width#

const uint16_t solidRect_width

The width of the maximum solid rectangle of the Bitmap.

solidRect_x#

const uint16_t solidRect_x

The x coordinate of the maximum solid rectangle of the Bitmap.

solidRect_y#

const uint16_t solidRect_y

The y coordinate of the maximum solid rectangle of the Bitmap.

width#

const uint16_t width

The width of the Bitmap.