nishi/nishbox
1
Fork 0
mirror of https://github.com/nishiowo/nishbox synced 2025-04-21 20:24:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
nishbox/engine/gf__client_8h_source.html

151 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GoldFish Engine: include/gf_client.h Source File</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" />
</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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="goldfish.png"/></td>
<td id="projectalign">
<div id="projectname">GoldFish Engine
</div>
<div id="projectbrief">Quite simple and lightweight game engine</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('gf__client_8h_source.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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">gf_client.h</div></div>
</div><!--header-->
<div class="contents">
<a href="gf__client_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifndef __GF_CLIENT_H__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define __GF_CLIENT_H__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;<a class="code" href="gf__pre_8h.html">gf_pre.h</a>&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;<a class="code" href="gf__macro_8h.html">gf_macro.h</a>&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">/* Type */</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;<a class="code" href="client_8h.html">gf_type/client.h</a>&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/* Engine */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;<a class="code" href="core_8h.html">gf_type/core.h</a>&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">/* Standard */</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_function" href="gf__client_8h.html#a190d30881f4449e141e915ac42e32d56">gf_client_begin</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_function" href="gf__client_8h.html#a48fc64674f40797eac53f689e2ba5bae">gf_client_end</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <a class="code hl_struct" href="structgf__client__t.html">gf_client_t</a>* <a class="code hl_function" href="gf__client_8h.html#a425bf9a148d3a4d1301686fa9628de5a">gf_client_create</a>(<a class="code hl_struct" href="structgf__engine__t.html">gf_engine_t</a>* engine, <span class="keyword">const</span> <span class="keywordtype">char</span>* title);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_function" href="gf__client_8h.html#a1f8b044a5ca56016e55dad76cd839b53">gf_client_destroy</a>(<a class="code hl_struct" href="structgf__client__t.html">gf_client_t</a>* client);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><a class="code hl_define" href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a> <span class="keywordtype">int</span> <a class="code hl_function" href="gf__client_8h.html#aa955ab564cc593944b7ea4ae10efd397">gf_client_step</a>(<a class="code hl_struct" href="structgf__client__t.html">gf_client_t</a>* client);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclient_8h_html"><div class="ttname"><a href="client_8h.html">client.h</a></div><div class="ttdoc">Type definitions related to client interface.</div></div>
<div class="ttc" id="acore_8h_html"><div class="ttname"><a href="core_8h.html">core.h</a></div><div class="ttdoc">Type definitions related to core.</div></div>
<div class="ttc" id="agf__client_8h_html_a190d30881f4449e141e915ac42e32d56"><div class="ttname"><a href="gf__client_8h.html#a190d30881f4449e141e915ac42e32d56">gf_client_begin</a></div><div class="ttdeci">void gf_client_begin(void)</div><div class="ttdoc">Initialize client interface.</div><div class="ttdef"><b>Definition</b> <a href="gf__client_8c_source.html#l00018">gf_client.c:18</a></div></div>
<div class="ttc" id="agf__client_8h_html_a1f8b044a5ca56016e55dad76cd839b53"><div class="ttname"><a href="gf__client_8h.html#a1f8b044a5ca56016e55dad76cd839b53">gf_client_destroy</a></div><div class="ttdeci">void gf_client_destroy(gf_client_t *client)</div><div class="ttdoc">Destroy client interface.</div><div class="ttdef"><b>Definition</b> <a href="gf__client_8c_source.html#l00035">gf_client.c:35</a></div></div>
<div class="ttc" id="agf__client_8h_html_a425bf9a148d3a4d1301686fa9628de5a"><div class="ttname"><a href="gf__client_8h.html#a425bf9a148d3a4d1301686fa9628de5a">gf_client_create</a></div><div class="ttdeci">gf_client_t * gf_client_create(gf_engine_t *engine, const char *title)</div><div class="ttdoc">Create client interface.</div><div class="ttdef"><b>Definition</b> <a href="gf__client_8c_source.html#l00022">gf_client.c:22</a></div></div>
<div class="ttc" id="agf__client_8h_html_a48fc64674f40797eac53f689e2ba5bae"><div class="ttname"><a href="gf__client_8h.html#a48fc64674f40797eac53f689e2ba5bae">gf_client_end</a></div><div class="ttdeci">void gf_client_end(void)</div><div class="ttdoc">Cleanup client interface.</div><div class="ttdef"><b>Definition</b> <a href="gf__client_8c_source.html#l00020">gf_client.c:20</a></div></div>
<div class="ttc" id="agf__client_8h_html_aa955ab564cc593944b7ea4ae10efd397"><div class="ttname"><a href="gf__client_8h.html#aa955ab564cc593944b7ea4ae10efd397">gf_client_step</a></div><div class="ttdeci">int gf_client_step(gf_client_t *client)</div><div class="ttdoc">Do client single step.</div><div class="ttdef"><b>Definition</b> <a href="gf__client_8c_source.html#l00041">gf_client.c:41</a></div></div>
<div class="ttc" id="agf__macro_8h_html"><div class="ttname"><a href="gf__macro_8h.html">gf_macro.h</a></div><div class="ttdoc">Macro.</div></div>
<div class="ttc" id="agf__macro_8h_html_a64ddd31b0795e397b5d944e6f1821357"><div class="ttname"><a href="gf__macro_8h.html#a64ddd31b0795e397b5d944e6f1821357">GF_EXPORT</a></div><div class="ttdeci">#define GF_EXPORT</div><div class="ttdoc">Macro for platform-dependent symbol export/import.</div><div class="ttdef"><b>Definition</b> <a href="gf__macro_8h_source.html#l00174">gf_macro.h:174</a></div></div>
<div class="ttc" id="agf__pre_8h_html"><div class="ttname"><a href="gf__pre_8h.html">gf_pre.h</a></div><div class="ttdoc">Required headers before anything.</div></div>
<div class="ttc" id="astructgf__client__t_html"><div class="ttname"><a href="structgf__client__t.html">gf_client_t</a></div><div class="ttdoc">Client interface.</div><div class="ttdef"><b>Definition</b> <a href="client_8h_source.html#l00036">client.h:36</a></div></div>
<div class="ttc" id="astructgf__engine__t_html"><div class="ttname"><a href="structgf__engine__t.html">gf_engine_t</a></div><div class="ttdoc">Engine instance.</div><div class="ttdef"><b>Definition</b> <a href="core_8h_source.html#l00044">core.h:44</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="gf__client_8h.html">gf_client.h</a></li>
<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.8 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink