Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished interface XIeeeFloatReadOnlyBitmap
Base Interfaces
XIeeeFloatReadOnlyBitmapXBitmap

XBitmap
(referenced interface's summary:)
This is a generic interface to a bitmap.
Usage Restrictions
not published
Description
Specialized interface for bitmaps containing IEEE floats as their color components. In contrast to XIeeeFloatBitmap, 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< float >
getData( [out] FloatingPointBitmapLayout  bitmapLayout,
[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 that the bitmap memory layout might change for volatile bitmaps.

Parameter bitmapLayout
The memory layout the returned data is in.
Parameter rect
A rectangle, within the bounds of the bitmap, to retrieve the contens from.
Throws
VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system.
Throws
com::sun::star::lang::IndexOutOfBoundsException if parts of the given rectangle are outside the permissible bitmap area.
getPixel
sequence< float >
getPixel( [out] FloatingPointBitmapLayout  bitmapLayout,
[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.

Note that the bitmap memory layout might change for volatile bitmaps.

Parameter bitmapLayout
The memory layout the returned data is in.
Parameter pos
A position, within the bounds of the bitmap, to retrieve the color from.
Throws
VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system.
Throws
com::sun::star::lang::IndexOutOfBoundsException if the given position is outside the permissible bitmap area.
getMemoryLayout
FloatingPointBitmapLayout
getMemoryLayout();

Description
Query the memory layout for this bitmap.

Please note that for volatile bitmaps, the memory layout might change between subsequent calls.

Top of Page

Apache Software Foundation

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

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