| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| |
| <title>android::RSC::RS Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| |
| |
| |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div! --> |
| |
| |
| <!-- Generated by Doxygen 1.7.5.1 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Overview</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Structs</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><b>android</b> </li> |
| <li class="navelem"><b>RSC</b> </li> |
| <li class="navelem"><a class="el" href="classandroid_1_1RSC_1_1RS.html">RS</a> </li> |
| </ul> |
| </div> |
| </div> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">android::RSC::RS Class Reference</div> </div> |
| </div> |
| <div class="contents"> |
| <!-- doxytag: class="android::RSC::RS" --> |
| <p><code>#include <<a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr><td colspan="2"><h2><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1RS.html#a04fd7161619e7b2ede4e54a14064097f">init</a> (std::string name, uint32_t flags=0)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1RS.html#a3e91e22835c85d230eba3ff1d20455a5">setErrorHandler</a> (ErrorHandlerFunc_t func)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">ErrorHandlerFunc_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1RS.html#aeb1f7ac6b745b64d56ea07f92d4003b1">getErrorHandler</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1RS.html#a37d0314f4a5f861da12355b4ca5ffee6">setMessageHandler</a> (MessageHandlerFunc_t func)</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">MessageHandlerFunc_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1RS.html#a5f1336fbd31c78a97a7bc9fdeccc6020">getMessageHandler</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">RSError </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1RS.html#a44f4660452aee0b1dbd747e383e531be">getError</a> ()</td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1RS.html#aff0d61c3a1fa1432a07dae0db14569c4">finish</a> ()</td></tr> |
| </table> |
| <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> |
| <div class="textblock"><p>The RenderScript context. This class controls initialization, resource management, and teardown. </p> |
| |
| <p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l00085">85</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p> |
| </div><hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="aff0d61c3a1fa1432a07dae0db14569c4"></a><!-- doxytag: member="android::RSC::RS::finish" ref="aff0d61c3a1fa1432a07dae0db14569c4" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void android::RSC::RS::finish </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Waits for any currently running asynchronous operations to finish. This should only be used for performance testing and timing. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a44f4660452aee0b1dbd747e383e531be"></a><!-- doxytag: member="android::RSC::RS::getError" ref="a44f4660452aee0b1dbd747e383e531be" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">RSError android::RSC::RS::getError </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Returns current status for the context.</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>current error </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aeb1f7ac6b745b64d56ea07f92d4003b1"></a><!-- doxytag: member="android::RSC::RS::getErrorHandler" ref="aeb1f7ac6b745b64d56ea07f92d4003b1" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ErrorHandlerFunc_t android::RSC::RS::getErrorHandler </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Returns the current error handler function for this context.</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>pointer to current error handler function or NULL if not set </dd></dl> |
| |
| <p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l00113">113</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5f1336fbd31c78a97a7bc9fdeccc6020"></a><!-- doxytag: member="android::RSC::RS::getMessageHandler" ref="a5f1336fbd31c78a97a7bc9fdeccc6020" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">MessageHandlerFunc_t android::RSC::RS::getMessageHandler </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Returns the current message handler function for this context.</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>pointer to current message handler function or NULL if not set </dd></dl> |
| |
| <p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l00128">128</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a04fd7161619e7b2ede4e54a14064097f"></a><!-- doxytag: member="android::RSC::RS::init" ref="a04fd7161619e7b2ede4e54a14064097f" args="(std::string name, uint32_t flags=0)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool android::RSC::RS::init </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>flags</em> = <code>0</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Initializes a RenderScript context. A context must be initialized before it can be used. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Directory name to be used by this context. This should be equivalent to Context.getCacheDir(). </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Optional flags for this context. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3e91e22835c85d230eba3ff1d20455a5"></a><!-- doxytag: member="android::RSC::RS::setErrorHandler" ref="a3e91e22835c85d230eba3ff1d20455a5" args="(ErrorHandlerFunc_t func)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void android::RSC::RS::setErrorHandler </td> |
| <td>(</td> |
| <td class="paramtype">ErrorHandlerFunc_t </td> |
| <td class="paramname"><em>func</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Sets the error handler function for this context. This error handler is called whenever an error is set.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Error handler function </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a37d0314f4a5f861da12355b4ca5ffee6"></a><!-- doxytag: member="android::RSC::RS::setMessageHandler" ref="a37d0314f4a5f861da12355b4ca5ffee6" args="(MessageHandlerFunc_t func)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void android::RSC::RS::setMessageHandler </td> |
| <td>(</td> |
| <td class="paramtype">MessageHandlerFunc_t </td> |
| <td class="paramname"><em>func</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Sets the message handler function for this context. This message handler is called whenever a message is sent from a RenderScript kernel.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Message handler function </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a></li> |
| </ul> |
| </div> |
| |
| </body> |
| </html> |