gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/time_8h.html
1 <!-- HTML header for doxygen 1.8.14-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="cache-control" content="max-age=86400"/>
6 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
8 <meta name="generator" content="Doxygen 1.9.2"/>
9 <meta name="viewport" content="width=device-width, initial-scale=1"/>
10 <title>GBDK 2020 Docs: gbdk-lib/include/time.h File Reference</title>
11 <link href="tabs.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="jquery.js"></script>
13 <script type="text/javascript" src="dynsections.js"></script>
14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
15 <script type="text/javascript" src="resize.js"></script>
16 <script type="text/javascript" src="navtreedata.js"></script>
17 <script type="text/javascript" src="navtree.js"></script>
18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
19 <script type="text/javascript" src="search/searchdata.js"></script>
20 <script type="text/javascript" src="search/search.js"></script>
21 <link href="doxygen.css" rel="stylesheet" type="text/css" />
22 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23 <link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
24 <link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
25 <!-- BEGIN: doxygen-awesome-css -->
26 <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
27 <script type="text/javascript">
28 DoxygenAwesomeDarkModeToggle.init()
29 </script>
30 <script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
31 <script type="text/javascript">
32 DoxygenAwesomeParagraphLink.init()
33 </script>
34 <!-- END: doxygen-awesome-css -->
35 </head>
36 <body>
37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <div id="titlearea">
39 <table cellspacing="0" cellpadding="0">
40 <tbody>
41 <tr style="height: 56px;">
42 <td id="projectalign" style="padding-left: 0.5em;">
43 <div id="projectname">GBDK 2020 Docs
44  <span id="projectnumber">4.5.0</span>
45 </div>
46 <div id="projectbrief">API Documentation for GBDK 2020</div>
47 </td>
48 </tr>
49 </tbody>
50 </table>
51 </div>
52 <!-- end header part -->
53 <!-- Generated by Doxygen 1.9.2 -->
54 <script type="text/javascript">
55 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
56 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
57 /* @license-end */
58 </script>
59 <script type="text/javascript" src="menudata.js"></script>
60 <script type="text/javascript" src="menu.js"></script>
61 <script type="text/javascript">
62 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
63 $(function() {
64 initMenu('',true,false,'search.php','Search');
65 $(document).ready(function() { init_search(); });
66 });
67 /* @license-end */
68 </script>
69 <div id="main-nav"></div>
70 </div><!-- top -->
71 <div id="side-nav" class="ui-resizable side-nav-resizable">
72 <div id="nav-tree">
73 <div id="nav-tree-contents">
74 <div id="nav-sync" class="sync"></div>
75 </div>
76 </div>
77 <div id="splitbar" style="-moz-user-select:none;"
78 class="ui-resizable-handle">
79 </div>
80 </div>
81 <script type="text/javascript">
82 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
83 $(document).ready(function(){initNavTree('time_8h.html',''); initResizable(); });
84 /* @license-end */
85 </script>
86 <div id="doc-content">
87 <!-- window showing the filter options -->
88 <div id="MSearchSelectWindow"
89 onmouseover="return searchBox.OnSearchSelectShow()"
90 onmouseout="return searchBox.OnSearchSelectHide()"
91 onkeydown="return searchBox.OnSearchSelectKey(event)">
92 </div>
93
94 <!-- iframe showing the search results (closed by default) -->
95 <div id="MSearchResultsWindow">
96 <iframe src="javascript:void(0)" frameborder="0"
97 name="MSearchResults" id="MSearchResults">
98 </iframe>
99 </div>
100
101 <div class="header">
102 <div class="summary">
103 <a href="#define-members">Macros</a> |
104 <a href="#typedef-members">Typedefs</a> |
105 <a href="#func-members">Functions</a> </div>
106 <div class="headertitle"><div class="title">time.h File Reference</div></div>
107 </div><!--header-->
108 <div class="contents">
109 <div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">types.h</a>></code><br />
110 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
111 </div>
112 <p><a href="time_8h_source.html">Go to the source code of this file.</a></p>
113 <table class="memberdecls">
114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
115 Macros</h2></td></tr>
116 <tr class="memitem:CLOCKS_PER_SEC"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="time_8h.html#CLOCKS_PER_SEC">CLOCKS_PER_SEC</a>   60</td></tr>
117 <tr class="separator:CLOCKS_PER_SEC"><td class="memSeparator" colspan="2"> </td></tr>
118 </table><table class="memberdecls">
119 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
120 Typedefs</h2></td></tr>
121 <tr class="memitem:time_t"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="time_8h.html#time_t">time_t</a></td></tr>
122 <tr class="separator:time_t"><td class="memSeparator" colspan="2"> </td></tr>
123 </table><table class="memberdecls">
124 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
125 Functions</h2></td></tr>
126 <tr class="memitem:clock"><td class="memItemLeft" align="right" valign="top"><a class="el" href="asm_2mos6502_2types_8h.html#clock_t">clock_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="time_8h.html#clock">clock</a> (void) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
127 <tr class="separator:clock"><td class="memSeparator" colspan="2"> </td></tr>
128 <tr class="memitem:time"><td class="memItemLeft" align="right" valign="top"><a class="el" href="time_8h.html#time_t">time_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="time_8h.html#time">time</a> (<a class="el" href="time_8h.html#time_t">time_t</a> *t)</td></tr>
129 <tr class="separator:time"><td class="memSeparator" colspan="2"> </td></tr>
130 </table>
131 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
132 <div class="textblock"><p >Sort of ANSI compliant time functions. </p>
133 </div><h2 class="groupheader">Macro Definition Documentation</h2>
134 <a id="CLOCKS_PER_SEC" name="CLOCKS_PER_SEC"></a>
135 <h2 class="memtitle"><span class="permalink"><a href="#CLOCKS_PER_SEC">◆ </a></span>CLOCKS_PER_SEC</h2>
136
137 <div class="memitem">
138 <div class="memproto">
139 <table class="memname">
140 <tr>
141 <td class="memname">#define CLOCKS_PER_SEC   60</td>
142 </tr>
143 </table>
144 </div><div class="memdoc">
145
146 </div>
147 </div>
148 <h2 class="groupheader">Typedef Documentation</h2>
149 <a id="time_t" name="time_t"></a>
150 <h2 class="memtitle"><span class="permalink"><a href="#time_t">◆ </a></span>time_t</h2>
151
152 <div class="memitem">
153 <div class="memproto">
154 <table class="memname">
155 <tr>
156 <td class="memname">typedef <a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> <a class="el" href="time_8h.html#time_t">time_t</a></td>
157 </tr>
158 </table>
159 </div><div class="memdoc">
160
161 </div>
162 </div>
163 <h2 class="groupheader">Function Documentation</h2>
164 <a id="clock" name="clock"></a>
165 <h2 class="memtitle"><span class="permalink"><a href="#clock">◆ </a></span>clock()</h2>
166
167 <div class="memitem">
168 <div class="memproto">
169 <table class="memname">
170 <tr>
171 <td class="memname"><a class="el" href="asm_2mos6502_2types_8h.html#clock_t">clock_t</a> clock </td>
172 <td>(</td>
173 <td class="paramtype">void </td>
174 <td class="paramname"></td><td>)</td>
175 <td></td>
176 </tr>
177 </table>
178 </div><div class="memdoc">
179 <p >Returns an approximation of processor time used by the program in Clocks</p>
180 <p >The value returned is the CPU time (ticks) used so far as a <a class="el" href="asm_2z80_2types_8h.html#clock_t">clock_t</a>.</p>
181 <p >To get the number of seconds used, divide by <a class="el" href="time_8h.html#CLOCKS_PER_SEC">CLOCKS_PER_SEC</a>.</p>
182 <p >This is based on <a class="el" href="sms_8h.html#sys_time">sys_time</a>, which will wrap around every ~18 minutes. (unsigned 16 bits = 65535 / 60 / 60 = 18.2)</p>
183 <dl class="section see"><dt>See also</dt><dd><a class="el" href="sms_8h.html#sys_time">sys_time</a>, <a class="el" href="time_8h.html#time">time()</a> </dd></dl>
184
185 </div>
186 </div>
187 <a id="time" name="time"></a>
188 <h2 class="memtitle"><span class="permalink"><a href="#time">◆ </a></span>time()</h2>
189
190 <div class="memitem">
191 <div class="memproto">
192 <table class="memname">
193 <tr>
194 <td class="memname"><a class="el" href="time_8h.html#time_t">time_t</a> time </td>
195 <td>(</td>
196 <td class="paramtype"><a class="el" href="time_8h.html#time_t">time_t</a> * </td>
197 <td class="paramname"><em>t</em></td><td>)</td>
198 <td></td>
199 </tr>
200 </table>
201 </div><div class="memdoc">
202 <p >Converts <a class="el" href="time_8h.html#clock">clock()</a> time to Seconds</p>
203 <dl class="params"><dt>Parameters</dt><dd>
204 <table class="params">
205 <tr><td class="paramname">t</td><td>If pointer <b>t</b> is not NULL, it's value will be set to the same seconds calculation as returned by the function.</td></tr>
206 </table>
207 </dd>
208 </dl>
209 <p>The calculation is <a class="el" href="time_8h.html#clock">clock()</a> / CLOCKS_PER_SEC</p>
210 <p >Returns: time in seconds </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="sms_8h.html#sys_time">sys_time</a>, <a class="el" href="time_8h.html#clock">clock()</a> </dd></dl>
211
212 </div>
213 </div>
214 </div><!-- contents -->
215 </div><!-- doc-content -->
216 <!-- start footer part -->
217 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
218 <ul>
219 <li class="navelem"><a class="el" href="dir_8bd3092e915ccc8a773a74e0a10d4d15.html">gbdk-lib</a></li><li class="navelem"><a class="el" href="dir_a9f896cff747ba031115e41245385c17.html">include</a></li><li class="navelem"><a class="el" href="time_8h.html">time.h</a></li>
220 <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
221 </ul>
222 </div>
223 </body>
224 </html>
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.