Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

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

unpublished interface XHalfFloatBitmap
Base Interfaces
XHalfFloatBitmapXBitmap
   ┗ ::com::sun::star::uno::XInterface

XBitmap
(referenced interface's summary:)
This is a generic interface to a bitmap.
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.

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. 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).  
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. 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. 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 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.
setData
void
setData( [in] sequence< short >  data,
[in] FloatingPointBitmapLayout  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. When setting subsets of the bitmap, the same scanline padding takes place as when the whole bitmap is changed.

setPixel
void
setPixel( [in] sequence< short >  color,
[in] FloatingPointBitmapLayout  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. 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< 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.