:: com :: sun :: star :: rendering ::

interface XIntegerBitmap
Base Interfaces
::com::sun::star::uno::XInterface
  |  
  +--XBitmap
       |  
       +--XIntegerBitmap
XBitmap
(referenced interface's summary:)
This is a generic interface to a bitmap.
Usage Restrictions
not published
Description
This is a specialized interface for bitmaps having integer color channels.

Methods' Summary
getData Query the raw data of this bitmap. 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. 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] ::com::sun::star::geometry::IntegerRectangle2D  rect )
raises( ::com::sun::star::lang::IndexOutOfBoundsException,
VolatileContentDestroyedException );

Description
Query the raw data of this bitmap. 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.
Throws
VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system.
setData
void
setData( [in] sequence< byte >  data,
[in] IntegerBitmapLayout  bitmapLayout,
[in] ::com::sun::star::geometry::IntegerRectangle2D  rect )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::IndexOutOfBoundsException );

Description
Set raw data of a bitmap. 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 >  color,
[in] IntegerBitmapLayout  bitmapLayout,
[in] ::com::sun::star::geometry::IntegerPoint2D  pos )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::IndexOutOfBoundsException );

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.

When setting data on volatile bitmaps, always call isValid() before, and retrieve a new memory layout via getMemoryLayout(). At least under Windows, the memory layout can change for the same bitmap, if the user e.g. switches the screen resolution. Thus, this method will throw an IllegalArgumentException, if the memory layout changed between a call to getMemoryLayout() and setData().

getPixel
sequence< byte >
getPixel( [in] ::com::sun::star::geometry::IntegerPoint2D  pos )
raises( ::com::sun::star::lang::IndexOutOfBoundsException,
VolatileContentDestroyedException );

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.
Throws
VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system.
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