Interface XIntegerBitmap

Devguide

Attributes' Summary

Attributes' Details

interface XIntegerBitmap

Base Hierarchy

XBitmap
 |
 +-XIntegerBitmap

Methods' Summary
getData	Query the raw data of this bitmap, in the format as defined by getMemoryLayout(). With the given rectangle, a subset of the whole bitmap can be queried. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte), the leftover content of the bytes at the right of each scanline is filled with zero. When querying subsets of the bitmap, the same scanline padding takes place as when the whole bitmap is requested.
setData	Set raw data of a bitmap, in the format as defined by getMemoryLayout(). With the given rectangle, a subset of the bitmap can be changed. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte), the leftover content of the bytes at the right of each scanline is ignored and left unchanged in the bitmap. When setting subsets of the bitmap, the same scanline padding takes place as when the whole bitmap is changed.
setPixel	Set a single pixel of the bitmap with the given color value. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte), the color value is expected in the least significant bits of the single byte given as the color.
getPixel	Get a single pixel of the bitmap, returning its color value. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte), the color value is returned in the least significant bits of the single byte returned as the color.
getPalette	Query the associated palette for this bitmap. Returns empty interface or interface with empty palette for non-paletted bitmaps.
getMemoryLayout	Query the memory layout for this bitmap

Methods' Details

getData

sequence< byte >
getData(

[in] Rectangle2D

rect );

Description: Query the raw data of this bitmap, in the format as defined by getMemoryLayout(). With the given rectangle, a subset of the whole bitmap can be queried. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte), the leftover content of the bytes at the right of each scanline is filled with zero. When querying subsets of the bitmap, the same scanline padding takes place as when the whole bitmap is requested.

setData

void
setData(

[in] sequence< byte >
[in] Rectangle2D

data,
rect );

Description: Set raw data of a bitmap, in the format as defined by getMemoryLayout(). With the given rectangle, a subset of the bitmap can be changed. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte), the leftover content of the bytes at the right of each scanline is ignored and left unchanged in the bitmap. When setting subsets of the bitmap, the same scanline padding takes place as when the whole bitmap is changed.

setPixel

void
setPixel(

[in] sequence< byte >
[in] Point2D

color,
pos );

Description: Set a single pixel of the bitmap with the given color value. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte), the color value is expected in the least significant bits of the single byte given as the color.

getPixel

sequence< byte >
getPixel(

[in] Point2D

pos );

Description: Get a single pixel of the bitmap, returning its color value. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte), the color value is returned in the least significant bits of the single byte returned as the color.

getPalette

XBitmapPalette
getPalette();

Description: Query the associated palette for this bitmap. Returns empty interface or interface with empty palette for non-paletted bitmaps.

getMemoryLayout

IntegerBitmapLayout
getMemoryLayout();

Description: Query the memory layout for this bitmap

Top of Page