Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 4652

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XHalfFloatBitmap</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="XHalfFloatBitmap-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 XHalfFloatBitmap</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XHalfFloatBitmap</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>Description</b></dt>
<dd>Specialized interface for bitmaps containing half floats as their
 color components. Half floats are 16 bit wide, and some high-end
 GPUs already have them as supported frame buffer format.
 </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.

 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: as we currently have no 16
 bit float UNO data type, the values are transported as 16 bit
 integers across the API (which requires casting on both
 sides).

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setData">setData</a></td>
<td class="imsum_right">Set raw data of a bitmap.

 Set raw data of a bitmap, in the format as defined by
 getMemoryLayout(). With the given rectangle, a subset of the
 bitmap can be changed. When setting subsets of the bitmap, the
 same scanline padding takes place as when the whole bitmap is
 changed.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setPixel">setPixel</a></td>
<td class="imsum_right">Set a single pixel of the bitmap with the given color
 value.

 When setting data on volatile bitmaps, always call isValid()
 before, and retrieve a new memory layout via
 getMemoryLayout(). At least under Windows, the memory layout
 can change for the same bitmap, if the user e.g. switches the
 screen resolution. Thus, this method will throw an
 IllegalArgumentException, if the memory layout changed between
 a call to getMemoryLayout() and setData().
 &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; short &gt;</td>
</tr>
<tr>
<td valign="top"><b>getData</b>(</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.

 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: as we currently have no 16
 bit float UNO data type, the values are transported as 16 bit
 integers across the API (which requires casting on both
 sides).

 </dd>
<dt><b>Throws</b></dt>
<dd>VolatileContentDestroyedException
 if the bitmap is volatile, and the content has been destroyed by the system.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setData" class="membertitle">setData</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">void</td>
</tr>
<tr>
<td valign="top"><b>setData</b>(</td>
<td valign="top">[in] sequence&lt; short &gt;</td>
<td valign="bottom">&nbsp;data,</td>
</tr>
<tr>
<td/><td valign="top">[in] <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/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set raw data of a bitmap.

 Set raw data of a bitmap, in the format as defined by
 getMemoryLayout(). With the given rectangle, a subset of the
 bitmap can be changed. When setting subsets of the bitmap, the
 same scanline padding takes place as when the whole bitmap is
 changed.</dd>
<dd><p>
 
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setPixel" class="membertitle">setPixel</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">void</td>
</tr>
<tr>
<td valign="top"><b>setPixel</b>(</td>
<td valign="top">[in] sequence&lt; short &gt;</td>
<td valign="bottom">&nbsp;color,</td>
</tr>
<tr>
<td/><td valign="top">[in] <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/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set a single pixel of the bitmap with the given color
 value.

 When setting data on volatile bitmaps, always call isValid()
 before, and retrieve a new memory layout via
 getMemoryLayout(). At least under Windows, the memory layout
 can change for the same bitmap, if the user e.g. switches the
 screen resolution. Thus, this method will throw an
 IllegalArgumentException, if the memory layout changed between
 a call to getMemoryLayout() and setData().
 </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; short &gt;</td>
</tr>
<tr>
<td valign="top"><b>getPixel</b>(</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>
<dt><b>Throws</b></dt>
<dd>VolatileContentDestroyedException
 if the bitmap is volatile, and the content has been destroyed by the system.
 </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>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

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

</html>