<html> <head> <title>Interface XBitmap</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XBitmap-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">rendering</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XBitmap</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This is a generic interface to a bitmap.</dd> <dd><p> This interface contains the generic functionality to be used on every <a href="XCanvas.html">XCanvas</a> bitmap object. More format-specific methods can be found at the <a href="XIntegerBitmap.html">XIntegerBitmap</a>, <a href="XIeeeDoubleBitmap.html">XIeeeDoubleBitmap</a>, <a href="XIeeeFloatBitmap.html">XIeeeFloatBitmap</a> and <a href="XHalfFloatBitmap.html">XHalfFloatBitmap</a> interfaces.<p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getSize">getSize</a></td> <td class="imsum_right">Query the size of the bitmap. </td> </tr> <tr> <td class="imsum_left"><a href="#hasAlpha">hasAlpha</a></td> <td class="imsum_right">Query transparency status of the bitmap. </td> </tr> <tr> <td class="imsum_left"><a href="#queryBitmapCanvas">queryBitmapCanvas</a></td> <td class="imsum_right">Query a canvas interface for this bitmap. </td> </tr> <tr> <td class="imsum_left"><a href="#getScaledBitmap">getScaledBitmap</a></td> <td class="imsum_right">Query a scaled version of the original bitmap. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getSize" class="membertitle">getSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/IntegerSize2D.html">IntegerSize2D</a></td> </tr> <tr> <td valign="top"><b>getSize</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Query the size of the bitmap.</dd> <dd><p> This method queries the bitmap size in pixel.<p> </dd> <dt><b>Returns</b></dt> <dd>the bitmap size in pixel. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasAlpha" class="membertitle">hasAlpha</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasAlpha</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Query transparency status of the bitmap.</dd> <dd><p> This method checks, whether the bitmap contains any alpha information.<p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b>, if the bitmap has alpha data, or <b>false</b> if not. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="queryBitmapCanvas" class="membertitle">queryBitmapCanvas</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XBitmapCanvas.html">XBitmapCanvas</a></td> </tr> <tr> <td valign="top"><b>queryBitmapCanvas</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Query a canvas interface for this bitmap.</dd> <dd><p> This method queries a canvas interface for this bitmap, to which draw operations can then be issued. Please note that concurrent draw operations on that <a href="XBitmapCanvas.html">XBitmapCanvas</a> interface and modifying operations on this bitmap interface might cause undesired effects. Although the implementations are required to not crash in this case, the result of such concurrent operations are <em>undefined</em> (i.e. anything else, including corruption of the bitmap data, or deadlocking, might actually happen). Thus, it is highly recommended to externally serialize the access here.<p> </dd> <dt><b>Returns</b></dt> <dd>an <a href="XBitmapCanvas.html">XBitmapCanvas</a> interface, whose rendering operations are directed into the bitmap. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getScaledBitmap" class="membertitle">getScaledBitmap</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XBitmap.html">XBitmap</a></td> </tr> <tr> <td valign="top"><b>getScaledBitmap</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/RealSize2D.html">RealSize2D</a></td> <td valign="bottom"> newSize,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> beFast )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> <a href="VolatileContentDestroyedException.html">VolatileContentDestroyedException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Query a scaled version of the original bitmap. </dd> <dt><b>Parameter newSize</b></dt> <dd>Requested size of the new bitmap. Both of the two size components must be greater than zero. </dd> <dt><b>Parameter beFast</b></dt> <dd>When set to true, this parameter advises getScaledBitmap to use the fastest available algorithm to scale the bitmap, which might cause visible artifacts. </dd> <dt><b>Returns</b></dt> <dd>the new scaled bitmap. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the size components are outside the specified range. </dd> <dt><b>Throws</b></dt> <dd>VolatileContentDestroyedException if the contents of a volatile bitmap have been destroyed, and thus cannot be read to generate the scaled bitmap. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>