Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: rendering ::
unpublished | interface XBitmap |
Usage Restrictions not published Description This is a generic interface to a bitmap. This interface contains the generic functionality to be used on every XCanvas bitmap object. More format-specific methods can be found at the XIntegerBitmap, XIeeeDoubleBitmap, XIeeeFloatBitmap and XHalfFloatBitmap interfaces. Since OOo 2.0

Methods' Summary
getSize | Query the size of the bitmap.
hasAlpha | Query transparency status of the bitmap.
getScaledBitmap | Query a scaled copy of the original bitmap.

Methods' Details
getSize
::com::sun::star::geometry::IntegerSize2D
getSize();
Description Query the size of the bitmap. This method queries the bitmap size in pixel. Returns the bitmap size in pixel.
hasAlpha
boolean
hasAlpha();
Description Query transparency status of the bitmap. The method checks, whether the bitmap contains any alpha information. The same information is also available at the XColorSpace associated with this bitmap, though much easier to access here (the color space then has a component flagged ColorComponentTag::ALPHA). Returns true, if the bitmap has alpha data, or false if not.
getScaledBitmap
XBitmap
getScaledBitmap( | [in] ::com::sun::star::geometry::RealSize2D | newSize,
| [in] boolean | beFast )
raises( | ::com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException );
Description Query a scaled copy of the original bitmap. Parameter newSize Requested size of the new bitmap. Both of the two size components must be greater than zero. Parameter beFast When set to true, this parameter advises getScaledBitmap to use the fastest available algorithm to scale the bitmap, which might cause visible artifacts. Returns the new scaled bitmap. Throws com::sun::star::lang::IllegalArgumentException if the size components are outside the specified range. Throws VolatileContentDestroyedException if the contents of a volatile bitmap have been destroyed, and thus cannot be read to generate the scaled bitmap.

Top of Page

Copyright © 2000, 2013 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.