Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 4840

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XIeeeFloatReadOnlyBitmap</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="XIeeeFloatReadOnlyBitmap-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">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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 XIeeeFloatReadOnlyBitmap</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XIeeeFloatReadOnlyBitmap</strong>
&#x2517 <a href="XBitmap.html">XBitmap</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XBitmap.html">XBitmap</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>This is a generic interface to a bitmap.</dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>Specialized interface for bitmaps containing IEEE floats as their
 color components. In contrast to <a href="XIeeeFloatBitmap.html">XIeeeFloatBitmap</a>,
 this interface only permits read-only access.</dd>
<dd><p>

 Use this interface for e.g. bitmaps that are calculated
 on-the-fly, or that are pure functional, and thus cannot be
 modified.<p>

 If you get passed an instance of
 <a href="XHalfFloatReadOnlyBitmap.html">XHalfFloatReadOnlyBitmap</a> that also supports the
 <a href="XVolatileBitmap.html">XVolatileBitmap</a> interface, things become a bit more
 complicated. When reading data, one has to check for both
 <a href="VolatileContentDestroyedException.html">VolatileContentDestroyedException</a> and mismatching
 <a href="FloatingPointBitmapLayout.html">FloatingPointBitmapLayout</a> return values. If either of them
 occurs, the whole bitmap read operation should be repeated.<p>
 </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="#getData">getData</a></td>
<td class="imsum_right">Query the raw data of this bitmap.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPixel">getPixel</a></td>
<td class="imsum_right">Get a single pixel of the bitmap, returning its color
 value.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getMemoryLayout">getMemoryLayout</a></td>
<td class="imsum_right">Query the memory layout for this bitmap.&nbsp;</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="getData" class="membertitle">getData</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">sequence&lt; float &gt;</td>
</tr>
<tr>
<td valign="top"><b>getData</b>(</td>
<td valign="top">[out] <a href="FloatingPointBitmapLayout.html">FloatingPointBitmapLayout</a></td>
<td valign="bottom">&nbsp;bitmapLayout,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/IntegerRectangle2D.html">IntegerRectangle2D</a></td>
<td valign="bottom">&nbsp;rect )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a>,<br>
<a href="VolatileContentDestroyedException.html">VolatileContentDestroyedException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query the raw data of this bitmap.</dd>
<dd><p>

 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.<p>

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

 </dd>
<dt><b>Parameter bitmapLayout</b></dt>
<dd>The memory layout the returned data is in.

 </dd>
<dt><b>Parameter rect</b></dt>
<dd>A rectangle, within the bounds of the bitmap, to retrieve the
 contens from.

 </dd>
<dt><b>Throws</b></dt>
<dd><a href="VolatileContentDestroyedException.html">VolatileContentDestroyedException</a>
 if the bitmap is volatile, and the content has been destroyed by the system.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IndexOutOfBoundsException
 if parts of the given rectangle are outside the permissible
 bitmap area.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPixel" class="membertitle">getPixel</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">sequence&lt; float &gt;</td>
</tr>
<tr>
<td valign="top"><b>getPixel</b>(</td>
<td valign="top">[out] <a href="FloatingPointBitmapLayout.html">FloatingPointBitmapLayout</a></td>
<td valign="bottom">&nbsp;bitmapLayout,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/IntegerPoint2D.html">IntegerPoint2D</a></td>
<td valign="bottom">&nbsp;pos )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a>,<br>
<a href="VolatileContentDestroyedException.html">VolatileContentDestroyedException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get a single pixel of the bitmap, returning its color
 value.</dd>
<dd><p>

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

 </dd>
<dt><b>Parameter bitmapLayout</b></dt>
<dd>The memory layout the returned data is in.

 </dd>
<dt><b>Parameter pos</b></dt>
<dd>A position, within the bounds of the bitmap, to retrieve the
 color from.

 </dd>
<dt><b>Throws</b></dt>
<dd><a href="VolatileContentDestroyedException.html">VolatileContentDestroyedException</a>
 if the bitmap is volatile, and the content has been destroyed by the system.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IndexOutOfBoundsException
 if the given position is outside the permissible bitmap area.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getMemoryLayout" class="membertitle">getMemoryLayout</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="FloatingPointBitmapLayout.html">FloatingPointBitmapLayout</a></td>
</tr>
<tr>
<td valign="top"><b>getMemoryLayout</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Query the memory layout for this bitmap.</dd>
<dd><p>

 Please note that for volatile bitmaps, the memory layout might
 change between subsequent calls.<p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>