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__core_8h.html

337 lines
15 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_core.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" />
</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>
</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__core_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">
<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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">gf_core.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Core.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="gf__pre_8h_source.html">gf_pre.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="gf__macro_8h_source.html">gf_macro.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="core_8h_source.html">gf_type/core.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="draw_8h_source.html">gf_type/draw.h</a>&gt;</code><br />
</div>
<p><a href="gf__core_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 id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ade0f3fb928e49b05985f095e95fb1f92" id="r_ade0f3fb928e49b05985f095e95fb1f92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__core_8h.html#ade0f3fb928e49b05985f095e95fb1f92">gf_engine_begin</a> (void)</td></tr>
<tr class="memdesc:ade0f3fb928e49b05985f095e95fb1f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize engine. <br /></td></tr>
<tr class="separator:ade0f3fb928e49b05985f095e95fb1f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abae48921e84f92d590608745536a9ffc" id="r_abae48921e84f92d590608745536a9ffc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__core_8h.html#abae48921e84f92d590608745536a9ffc">gf_engine_end</a> (void)</td></tr>
<tr class="memdesc:abae48921e84f92d590608745536a9ffc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cleanup engine. <br /></td></tr>
<tr class="separator:abae48921e84f92d590608745536a9ffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a741291298ef02f3dceb1fdeaee2e27b4" id="r_a741291298ef02f3dceb1fdeaee2e27b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgf__engine__t.html">gf_engine_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__core_8h.html#a741291298ef02f3dceb1fdeaee2e27b4">gf_engine_create</a> (const char *title, int nogui)</td></tr>
<tr class="memdesc:a741291298ef02f3dceb1fdeaee2e27b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create engine instance. <br /></td></tr>
<tr class="separator:a741291298ef02f3dceb1fdeaee2e27b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9a229aa7c06d1a02ae89f93b8029fea" id="r_aa9a229aa7c06d1a02ae89f93b8029fea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__core_8h.html#aa9a229aa7c06d1a02ae89f93b8029fea">gf_engine_loop</a> (<a class="el" href="structgf__engine__t.html">gf_engine_t</a> *engine)</td></tr>
<tr class="memdesc:aa9a229aa7c06d1a02ae89f93b8029fea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start engine main loop. <br /></td></tr>
<tr class="separator:aa9a229aa7c06d1a02ae89f93b8029fea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a978d9c52b1d1098b5fc2f3e869036b64" id="r_a978d9c52b1d1098b5fc2f3e869036b64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gf__core_8h.html#a978d9c52b1d1098b5fc2f3e869036b64">gf_engine_destroy</a> (<a class="el" href="structgf__engine__t.html">gf_engine_t</a> *engine)</td></tr>
<tr class="memdesc:a978d9c52b1d1098b5fc2f3e869036b64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy engine instance. <br /></td></tr>
<tr class="separator:a978d9c52b1d1098b5fc2f3e869036b64"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Core. </p>
<p class="definition">Definition in file <a class="el" href="gf__core_8h_source.html">gf_core.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ade0f3fb928e49b05985f095e95fb1f92" name="ade0f3fb928e49b05985f095e95fb1f92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade0f3fb928e49b05985f095e95fb1f92">&#9670;&#160;</a></span>gf_engine_begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gf_engine_begin </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize engine. </p>
<p class="definition">Definition at line <a class="el" href="gf__core_8c_source.html#l00024">24</a> of file <a class="el" href="gf__core_8c_source.html">gf_core.c</a>.</p>
</div>
</div>
<a id="a741291298ef02f3dceb1fdeaee2e27b4" name="a741291298ef02f3dceb1fdeaee2e27b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a741291298ef02f3dceb1fdeaee2e27b4">&#9670;&#160;</a></span>gf_engine_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgf__engine__t.html">gf_engine_t</a> * gf_engine_create </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>title</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nogui</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create engine instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">title</td><td>Title to be shown on the window </td></tr>
<tr><td class="paramname">nogui</td><td><code>0</code> to enable client-part, otherwise disable client-part </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Engine instance </dd></dl>
<p class="definition">Definition at line <a class="el" href="gf__core_8c_source.html#l00049">49</a> of file <a class="el" href="gf__core_8c_source.html">gf_core.c</a>.</p>
</div>
</div>
<a id="a978d9c52b1d1098b5fc2f3e869036b64" name="a978d9c52b1d1098b5fc2f3e869036b64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a978d9c52b1d1098b5fc2f3e869036b64">&#9670;&#160;</a></span>gf_engine_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gf_engine_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgf__engine__t.html">gf_engine_t</a> *&#160;</td>
<td class="paramname"><em>engine</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy engine instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>Engine instance </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="gf__core_8c_source.html#l00092">92</a> of file <a class="el" href="gf__core_8c_source.html">gf_core.c</a>.</p>
</div>
</div>
<a id="abae48921e84f92d590608745536a9ffc" name="abae48921e84f92d590608745536a9ffc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abae48921e84f92d590608745536a9ffc">&#9670;&#160;</a></span>gf_engine_end()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gf_engine_end </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Cleanup engine. </p>
<p class="definition">Definition at line <a class="el" href="gf__core_8c_source.html#l00044">44</a> of file <a class="el" href="gf__core_8c_source.html">gf_core.c</a>.</p>
</div>
</div>
<a id="aa9a229aa7c06d1a02ae89f93b8029fea" name="aa9a229aa7c06d1a02ae89f93b8029fea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9a229aa7c06d1a02ae89f93b8029fea">&#9670;&#160;</a></span>gf_engine_loop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void gf_engine_loop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgf__engine__t.html">gf_engine_t</a> *&#160;</td>
<td class="paramname"><em>engine</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start engine main loop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine</td><td>Engine instance </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>How engine draws a frame internally is explained in <a class="el" href="gf__core_8c_source.html">gf_core.c</a></dd></dl>
<p>Writing this so I don't forget</p>
<ol type="1">
<li>Calls gf_client_step</li>
<li>gf_client_step calls gf_draw_step</li>
<li>gf_draw_step calls gf_draw_platform_step (Platform-dependent)</li>
<li>gf_draw_platform_step processes platform-dependent stuffs (e.g. events)</li>
<li>gf_draw_platform_step calls gf_draw_driver_before</li>
<li>gf_draw_platform_step calls gf_draw_frame</li>
<li>gf_draw_frame draws stuffs</li>
<li>gf_draw_platform_step calls gf_draw_driver_after</li>
<li>gf_draw_platform_step swaps buffers</li>
<li>Comes back here </li>
</ol>
<p class="definition">Definition at line <a class="el" href="gf__core_8c_source.html#l00084">84</a> of file <a class="el" href="gf__core_8c_source.html">gf_core.c</a>.</p>
</div>
</div>
</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__core_8h.html">gf_core.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