<html> <head> <title>Interface XBufferController</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="XBufferController-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 XBufferController</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Interface providing access to double/multi-buffer facilities of screen devices.</dd> <dd><p> This interface provides methods to enable and control double/multi-buffering facilities on screen devices.<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="#createBuffers">createBuffers</a></td> <td class="imsum_right">Create the given number of background buffers. </td> </tr> <tr> <td class="imsum_left"><a href="#destroyBuffers">destroyBuffers</a></td> <td class="imsum_right">Destroy all buffers generated via this object. </td> </tr> <tr> <td class="imsum_left"><a href="#showBuffer">showBuffer</a></td> <td class="imsum_right">Switch the display to show the specified buffer. </td> </tr> <tr> <td class="imsum_left"><a href="#switchBuffer">switchBuffer</a></td> <td class="imsum_right">Schedule the display of the specified buffer. </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="createBuffers" class="membertitle">createBuffers</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">long</td> </tr> <tr> <td valign="top"><b>createBuffers</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nBuffers )</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Create the given number of background buffers.</dd> <dd><p> There's one buffer implicitely available, which is the canvas surface itself. Thus, calling <code>createBuffers(1)</code> creates a double-buffered object.<p> </dd> <dt><b>Parameter nBuffers</b></dt> <dd>The number of background<buffers requested. Must be greater than 0. </dd> <dt><b>Returns</b></dt> <dd>the number of actually generated buffers, which might be between 0 (no double-buffering available) and nBuffers. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if nBuffers is smaller than one. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="destroyBuffers" class="membertitle">destroyBuffers</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>destroyBuffers</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Destroy all buffers generated via this object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="showBuffer" class="membertitle">showBuffer</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>showBuffer</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bUpdateAll );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Switch the display to show the specified buffer.</dd> <dd><p> The method returns, when the switch is performed and the selected buffer is shown on screen, or immediately when an error occurs. If the switch was successful, subsequent render operations will be directed to the new backbuffer.<p> Use this method if you need your screen display to be in sync with other things, e.g. sound playback.<p> </dd> <dt><b>Parameter bUpdateAll</b></dt> <dd>When <b>true</b>, update the whole screen. When <b>false</b>, implementation is permitted to restrict update to areas the canvas itself changed (e.g. because of render operations, or changes on the sprites). The former is useful for updates after window expose events, the latter for animation display. </dd> <dt><b>Returns</b></dt> <dd>whether the switch was performed successfully. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if nBuffer is outside the permissible range. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="switchBuffer" class="membertitle">switchBuffer</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>switchBuffer</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bUpdateAll );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Schedule the display of the specified buffer.</dd> <dd><p> The method returns, when the switching of the buffer is successfully scheduled, or immediately when an error occurs. If the switch was successful, subsequent render operations will be directed to the new backbuffer. Note that, if the buffer switching is exceedingly slow, or the frequency of switchBuffer() is exceedingly high, the buffer scheduled for display here might become the current render target <em>before</em> it is fully displayed on screen. In this case, any rendering operation to this buffer will block, until it is safe to perform the operation without visible cluttering.<p> Use this method if you favor maximal render speed, but don't necessarily require your screen display to be in sync with other things, e.g. sound playback.<p> </dd> <dt><b>Parameter bUpdateAll</b></dt> <dd>When <b>true</b>, update the whole screen. When <b>false</b>, implementation is permitted to restrict update to areas the canvas itself changed (e.g. because of render operations, or changes on the sprites). The former is useful for updates after window expose events, the latter for animation display. </dd> <dt><b>Returns</b></dt> <dd>whether the switch was performed successfully. </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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4638
