Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished interface XHalfFloatReadOnlyBitmap
Base Interfaces
XHalfFloatReadOnlyBitmapXBitmap

XBitmap
(referenced interface's summary:)
This is a generic interface to a bitmap.
Usage Restrictions
not published
Description
Specialized interface for bitmaps containing half floats as their color components. Half floats are 16 bit wide, and some high-end GPUs already have them as supported frame buffer format. In contrast to XHalfFloatBitmap, this interface only permits read-only access.

Use this interface for e.g. bitmaps that are calculated on-the-fly, or that are pure functional, and thus cannot be modified.

If you get passed an instance of XHalfFloatReadOnlyBitmap that also supports the XVolatileBitmap interface, things become a bit more complicated. When reading data, one has to check for both VolatileContentDestroyedException and mismatching FloatingPointBitmapLayout return values. If either of them occurs, the whole bitmap read operation should be repeated.


Methods' Summary
getData Query the raw data of this bitmap. 
getPixel Get a single pixel of the bitmap, returning its color value. 
getMemoryLayout Query the memory layout for this bitmap. 
Methods' Details
getData
sequence< short >
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. When querying subsets of the bitmap, the same scanline padding takes place as when the whole bitmap is requested. Note: as we currently have no 16 bit float UNO data type, the values are transported as 16 bit integers across the API (which requires casting on both sides).

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

Throws
VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system.
getMemoryLayout
FloatingPointBitmapLayout
getMemoryLayout();

Description
Query the memory layout for this bitmap.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.