Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: rendering ::
unpublished | interface XIntegerReadOnlyBitmap |
  Base Interfaces
      XIntegerReadOnlyBitmap
      ┗ XBitmap
  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. In contrast to XIntegerBitmap, 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 XIntegerReadOnlyBitmap that also supports the XVolatileBitmap interface, things become a bit more complicated. When reading data, one has to check for both VolatileContentDestroyedException and mismatching IntegerBitmapLayout return values. If either of them occurs, the whole bitmap read operation should be repeated, if you need consistent information.

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< byte >
getData( | [out] IntegerBitmapLayout | 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. 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 zeros. The details of the scanline padding are to be retrieved from the passed bitmap layout. Note that the bitmap memory layout might change over time for volatile bitmaps. Parameter bitmapLayout The memory layout the returned data is in. Note that the color space returned therein needs to always match the current color space as would have been returned by getMemoryLayout(). This is necessary to ensure correct operation under changing XVolatileBitmap. Parameter rect A rectangle, within the bounds of the bitmap, to retrieve the consent 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< byte >
getPixel( | [out] IntegerBitmapLayout | 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. If the internal data format's pixel are not integer multiples of bytes (i.e. if one pixel occupies less than a byte - the case of more than one byte per pixel is not specified), the color value is returned in the least significant bits of the single byte returned as the color. The details of the returned pixel data are to be retrieved from the passed bitmap layout. Note that the bitmap memory layout might change for volatile bitmaps. Parameter bitmapLayout The memory layout the returned data is in. Note that the color space returned therein needs to always match the current color space as would have been returned by getMemoryLayout(). This is necessary to ensure correct operation under changing XVolatileBitmap. 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
IntegerBitmapLayout
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

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.