Home | History | Annotate | Download | only in renderscript
      1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
      2 <html xmlns="http://www.w3.org/1999/xhtml">
      3 <head>
      4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
      5 
      6 <title>/usr/local/google/home/srhines/android_trees/jb-mr2-dev/frameworks/rs/scriptc/rs_time.rsh File Reference</title>
      7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
      8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
      9 
     10 
     11 
     12 </head>
     13 <body>
     14 <div id="top"><!-- do not remove this div! -->
     15 
     16 
     17 <!-- Generated by Doxygen 1.7.5.1 -->
     18   <div id="navrow1" class="tabs">
     19     <ul class="tablist">
     20       <li><a href="index.html"><span>Overview</span></a></li>
     21       <li class="current"><a href="globals.html"><span>Globals</span></a></li>
     22       <li><a href="annotated.html"><span>Structs</span></a></li>
     23     </ul>
     24   </div>
     25 </div>
     26 <div class="header">
     27   <div class="summary">
     28 <a href="#nested-classes">Data Structures</a> &#124;
     29 <a href="#typedef-members">Typedefs</a> &#124;
     30 <a href="#func-members">Functions</a>  </div>
     31   <div class="headertitle">
     32 <div class="title">/usr/local/google/home/srhines/android_trees/jb-mr2-dev/frameworks/rs/scriptc/rs_time.rsh File Reference</div>  </div>
     33 </div>
     34 <div class="contents">
     35 <table class="memberdecls">
     36 <tr><td colspan="2"><h2><a name="nested-classes"></a>
     37 Data Structures</h2></td></tr>
     38 <tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrs__tm.html">rs_tm</a></td></tr>
     39 <tr><td colspan="2"><h2><a name="typedef-members"></a>
     40 Typedefs</h2></td></tr>
     41 <tr><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rs__time_8rsh.html#ad2b4759a0a6a98bd79b7ad82a4b057d6">rs_time_t</a></td></tr>
     42 <tr><td colspan="2"><h2><a name="func-members"></a>
     43 Functions</h2></td></tr>
     44 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="rs__time_8rsh.html#ad2b4759a0a6a98bd79b7ad82a4b057d6">rs_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rs__time_8rsh.html#a555f9324acb8c3d0c6f09a1d05478ce2">rsTime</a> (<a class="el" href="rs__time_8rsh.html#ad2b4759a0a6a98bd79b7ad82a4b057d6">rs_time_t</a> *timer)</td></tr>
     45 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structrs__tm.html">rs_tm</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rs__time_8rsh.html#a08a8fcadae964f7416aef487da624110">rsLocaltime</a> (<a class="el" href="structrs__tm.html">rs_tm</a> *local, const <a class="el" href="rs__time_8rsh.html#ad2b4759a0a6a98bd79b7ad82a4b057d6">rs_time_t</a> *timer)</td></tr>
     46 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="rs__types_8rsh.html#a996e72f71b11a5bb8b3b7b6936b1516d">int64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rs__time_8rsh.html#a3c406e51a769718dd1c760518b9cad44">rsUptimeMillis</a> (void)</td></tr>
     47 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="rs__types_8rsh.html#a996e72f71b11a5bb8b3b7b6936b1516d">int64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rs__time_8rsh.html#a24e2cc12acf1e7fdd857d1a48981395d">rsUptimeNanos</a> (void)</td></tr>
     48 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="rs__time_8rsh.html#adea2682186fd903752431ad848bd8bf4">rsGetDt</a> (void)</td></tr>
     49 </table>
     50 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
     51 <div class="textblock"><p>RenderScript time routines. </p>
     52 <p>This file contains RenderScript functions relating to time and date manipulation. </p>
     53 
     54 <p>Definition in file <a class="el" href="rs__time_8rsh_source.html">rs_time.rsh</a>.</p>
     55 </div><hr/><h2>Typedef Documentation</h2>
     56 <a class="anchor" id="ad2b4759a0a6a98bd79b7ad82a4b057d6"></a><!-- doxytag: member="rs_time.rsh::rs_time_t" ref="ad2b4759a0a6a98bd79b7ad82a4b057d6" args="" -->
     57 <div class="memitem">
     58 <div class="memproto">
     59       <table class="memname">
     60         <tr>
     61           <td class="memname">typedef int <a class="el" href="rs__time_8rsh.html#ad2b4759a0a6a98bd79b7ad82a4b057d6">rs_time_t</a></td>
     62         </tr>
     63       </table>
     64 </div>
     65 <div class="memdoc">
     66 <p>Calendar time interpreted as seconds elapsed since the Epoch (00:00:00 on January 1, 1970, Coordinated Universal Time (UTC)). </p>
     67 
     68 <p>Definition at line <a class="el" href="rs__time_8rsh_source.html#l00031">31</a> of file <a class="el" href="rs__time_8rsh_source.html">rs_time.rsh</a>.</p>
     69 
     70 </div>
     71 </div>
     72 <hr/><h2>Function Documentation</h2>
     73 <a class="anchor" id="adea2682186fd903752431ad848bd8bf4"></a><!-- doxytag: member="rs_time.rsh::rsGetDt" ref="adea2682186fd903752431ad848bd8bf4" args="(void)" -->
     74 <div class="memitem">
     75 <div class="memproto">
     76       <table class="memname">
     77         <tr>
     78           <td class="memname">float rsGetDt </td>
     79           <td>(</td>
     80           <td class="paramtype">void&#160;</td>
     81           <td class="paramname"></td><td>)</td>
     82           <td></td>
     83         </tr>
     84       </table>
     85 </div>
     86 <div class="memdoc">
     87 <p>Returns the time in seconds since this function was last called in this script.</p>
     88 <dl class="return"><dt><b>Returns:</b></dt><dd>Time in seconds. </dd></dl>
     89 
     90 </div>
     91 </div>
     92 <a class="anchor" id="a08a8fcadae964f7416aef487da624110"></a><!-- doxytag: member="rs_time.rsh::rsLocaltime" ref="a08a8fcadae964f7416aef487da624110" args="(rs_tm *local, const rs_time_t *timer)" -->
     93 <div class="memitem">
     94 <div class="memproto">
     95       <table class="memname">
     96         <tr>
     97           <td class="memname"><a class="el" href="structrs__tm.html">rs_tm</a>* rsLocaltime </td>
     98           <td>(</td>
     99           <td class="paramtype"><a class="el" href="structrs__tm.html">rs_tm</a> *&#160;</td>
    100           <td class="paramname"><em>local</em>, </td>
    101         </tr>
    102         <tr>
    103           <td class="paramkey"></td>
    104           <td></td>
    105           <td class="paramtype">const <a class="el" href="rs__time_8rsh.html#ad2b4759a0a6a98bd79b7ad82a4b057d6">rs_time_t</a> *&#160;</td>
    106           <td class="paramname"><em>timer</em>&#160;</td>
    107         </tr>
    108         <tr>
    109           <td></td>
    110           <td>)</td>
    111           <td></td><td></td>
    112         </tr>
    113       </table>
    114 </div>
    115 <div class="memdoc">
    116 <p>Converts the time specified by <code>timer</code> into broken-down time and stores it in <code>local</code>. This function also returns a pointer to <code>local</code>. If <code>local</code> is NULL, this function does nothing and returns NULL.</p>
    117 <dl><dt><b>Parameters:</b></dt><dd>
    118   <table class="params">
    119     <tr><td class="paramname">local</td><td>Broken-down time. </td></tr>
    120     <tr><td class="paramname">timer</td><td>Input time as calendar time.</td></tr>
    121   </table>
    122   </dd>
    123 </dl>
    124 <dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to broken-down time (same as input <code>local</code>). </dd></dl>
    125 
    126 </div>
    127 </div>
    128 <a class="anchor" id="a555f9324acb8c3d0c6f09a1d05478ce2"></a><!-- doxytag: member="rs_time.rsh::rsTime" ref="a555f9324acb8c3d0c6f09a1d05478ce2" args="(rs_time_t *timer)" -->
    129 <div class="memitem">
    130 <div class="memproto">
    131       <table class="memname">
    132         <tr>
    133           <td class="memname"><a class="el" href="rs__time_8rsh.html#ad2b4759a0a6a98bd79b7ad82a4b057d6">rs_time_t</a> rsTime </td>
    134           <td>(</td>
    135           <td class="paramtype"><a class="el" href="rs__time_8rsh.html#ad2b4759a0a6a98bd79b7ad82a4b057d6">rs_time_t</a> *&#160;</td>
    136           <td class="paramname"><em>timer</em></td><td>)</td>
    137           <td></td>
    138         </tr>
    139       </table>
    140 </div>
    141 <div class="memdoc">
    142 <p>Returns the number of seconds since the Epoch (00:00:00 UTC, January 1, 1970). If <code>timer</code> is non-NULL, the result is also stored in the memory pointed to by this variable. If an error occurs, a value of -1 is returned.</p>
    143 <dl><dt><b>Parameters:</b></dt><dd>
    144   <table class="params">
    145     <tr><td class="paramname">timer</td><td>Location to also store the returned calendar time.</td></tr>
    146   </table>
    147   </dd>
    148 </dl>
    149 <dl class="return"><dt><b>Returns:</b></dt><dd>Seconds since the Epoch. </dd></dl>
    150 
    151 </div>
    152 </div>
    153 <a class="anchor" id="a3c406e51a769718dd1c760518b9cad44"></a><!-- doxytag: member="rs_time.rsh::rsUptimeMillis" ref="a3c406e51a769718dd1c760518b9cad44" args="(void)" -->
    154 <div class="memitem">
    155 <div class="memproto">
    156       <table class="memname">
    157         <tr>
    158           <td class="memname"><a class="el" href="rs__types_8rsh.html#a996e72f71b11a5bb8b3b7b6936b1516d">int64_t</a> rsUptimeMillis </td>
    159           <td>(</td>
    160           <td class="paramtype">void&#160;</td>
    161           <td class="paramname"></td><td>)</td>
    162           <td></td>
    163         </tr>
    164       </table>
    165 </div>
    166 <div class="memdoc">
    167 <p>Returns the current system clock (uptime) in milliseconds.</p>
    168 <dl class="return"><dt><b>Returns:</b></dt><dd>Uptime in milliseconds. </dd></dl>
    169 
    170 </div>
    171 </div>
    172 <a class="anchor" id="a24e2cc12acf1e7fdd857d1a48981395d"></a><!-- doxytag: member="rs_time.rsh::rsUptimeNanos" ref="a24e2cc12acf1e7fdd857d1a48981395d" args="(void)" -->
    173 <div class="memitem">
    174 <div class="memproto">
    175       <table class="memname">
    176         <tr>
    177           <td class="memname"><a class="el" href="rs__types_8rsh.html#a996e72f71b11a5bb8b3b7b6936b1516d">int64_t</a> rsUptimeNanos </td>
    178           <td>(</td>
    179           <td class="paramtype">void&#160;</td>
    180           <td class="paramname"></td><td>)</td>
    181           <td></td>
    182         </tr>
    183       </table>
    184 </div>
    185 <div class="memdoc">
    186 <p>Returns the current system clock (uptime) in nanoseconds.</p>
    187 <dl class="return"><dt><b>Returns:</b></dt><dd>Uptime in nanoseconds. </dd></dl>
    188 
    189 </div>
    190 </div>
    191 </div>
    192 
    193 </body>
    194 </html>
    195