diff options
Diffstat (limited to 'gbdk/docs/api/time_8h.html')
| -rw-r--r-- | gbdk/docs/api/time_8h.html | 208 |
1 files changed, 208 insertions, 0 deletions
diff --git a/gbdk/docs/api/time_8h.html b/gbdk/docs/api/time_8h.html new file mode 100644 index 00000000..f523e6ba --- /dev/null +++ b/gbdk/docs/api/time_8h.html @@ -0,0 +1,208 @@ +<!-- HTML header for doxygen 1.8.14--> +<!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="cache-control" content="max-age=86400"/> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.20"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>GBDK 2020 Docs: time.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">GBDK 2020 Docs +  <span id="projectnumber">4.0.6</span> + </div> + <div id="projectbrief">API Documentation for GBDK 2020</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.20 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('time_8h.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#define-members">Macros</a> | +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">time.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">types.h</a>></code><br /> +<code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br /> +</div> +<p><a href="time_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:a3d9fc3c745d0880902fe3ea3d5d5f71e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="time_8h.html#a3d9fc3c745d0880902fe3ea3d5d5f71e">CLOCKS_PER_SEC</a>   60</td></tr> +<tr class="separator:a3d9fc3c745d0880902fe3ea3d5d5f71e"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:ac84921d4d15eedac7d7b8051a7944c84"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="time_8h.html#ac84921d4d15eedac7d7b8051a7944c84">time_t</a></td></tr> +<tr class="separator:ac84921d4d15eedac7d7b8051a7944c84"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:acc1f88818af5706d57262377382ae4ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="asm_2gbz80_2types_8h.html#aeb756bd89bf86769edbefdef8135109f">clock_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="time_8h.html#acc1f88818af5706d57262377382ae4ac">clock</a> () <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> +<tr class="separator:acc1f88818af5706d57262377382ae4ac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae7841e681c8c9d59818568d39553642c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="time_8h.html#ac84921d4d15eedac7d7b8051a7944c84">time_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="time_8h.html#ae7841e681c8c9d59818568d39553642c">time</a> (<a class="el" href="time_8h.html#ac84921d4d15eedac7d7b8051a7944c84">time_t</a> *t)</td></tr> +<tr class="separator:ae7841e681c8c9d59818568d39553642c"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Sort of ANSI compliant time functions. </p> +</div><h2 class="groupheader">Macro Definition Documentation</h2> +<a id="a3d9fc3c745d0880902fe3ea3d5d5f71e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3d9fc3c745d0880902fe3ea3d5d5f71e">◆ </a></span>CLOCKS_PER_SEC</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define CLOCKS_PER_SEC   60</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Typedef Documentation</h2> +<a id="ac84921d4d15eedac7d7b8051a7944c84"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac84921d4d15eedac7d7b8051a7944c84">◆ </a></span>time_t</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef <a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a> <a class="el" href="time_8h.html#ac84921d4d15eedac7d7b8051a7944c84">time_t</a></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="acc1f88818af5706d57262377382ae4ac"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acc1f88818af5706d57262377382ae4ac">◆ </a></span>clock()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="asm_2gbz80_2types_8h.html#aeb756bd89bf86769edbefdef8135109f">clock_t</a> clock </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns an approximation of processor time used by the program in Clocks</p> +<p>The value returned is the CPU time (ticks) used so far as a <a class="el" href="asm_2z80_2types_8h.html#aeb756bd89bf86769edbefdef8135109f">clock_t</a>.</p> +<p>To get the number of seconds used, divide by <a class="el" href="time_8h.html#a3d9fc3c745d0880902fe3ea3d5d5f71e">CLOCKS_PER_SEC</a>.</p> +<p>This is based on <a class="el" href="sms_8h.html#a78d2fd18666afec116f176d46debb4e7">sys_time</a>, which will wrap around every ~18 minutes. (unsigned 16 bits = 65535 / 60 / 60 = 18.2)</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="sms_8h.html#a78d2fd18666afec116f176d46debb4e7">sys_time</a>, <a class="el" href="time_8h.html#ae7841e681c8c9d59818568d39553642c">time()</a> </dd></dl> + +</div> +</div> +<a id="ae7841e681c8c9d59818568d39553642c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae7841e681c8c9d59818568d39553642c">◆ </a></span>time()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="time_8h.html#ac84921d4d15eedac7d7b8051a7944c84">time_t</a> time </td> + <td>(</td> + <td class="paramtype"><a class="el" href="time_8h.html#ac84921d4d15eedac7d7b8051a7944c84">time_t</a> * </td> + <td class="paramname"><em>t</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Converts <a class="el" href="time_8h.html#acc1f88818af5706d57262377382ae4ac">clock()</a> time to Seconds</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <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> + </table> + </dd> +</dl> +<p>The calculation is <a class="el" href="time_8h.html#acc1f88818af5706d57262377382ae4ac">clock()</a> / CLOCKS_PER_SEC</p> +<p>Returns: time in seconds </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="sms_8h.html#a78d2fd18666afec116f176d46debb4e7">sys_time</a>, <a class="el" href="time_8h.html#acc1f88818af5706d57262377382ae4ac">clock()</a> </dd></dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> +</div> +</body> +</html> |