Skip to content

Commit c65604b

Browse files
jubejube
committed
add documentation for version 0.22.0
1 parent cbd3655 commit c65604b

File tree

2,164 files changed

+230725
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,164 files changed

+230725
-1
lines changed

‎index.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ <h1>Gamedev Framework (gf)</h1>
3232

3333
<h2>Releases</h2>
3434

35+
<h3>gf 0.22.0 (14 Jan 2022)</h3>
36+
37+
<ul>
38+
<li><a href="v0.22.0">Documentation for gf 0.22.0</a></li>
39+
<li><a href="https://github.com/GamedevFramework/gf/archive/v0.22.0.tar.gz">Source code for gf 0.22.0</a></li>
40+
</ul>
41+
3542
<h3>gf 0.21.0 (14 Jul 2021)</h3>
3643

3744
<ul>

‎latest‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v0.21.0
1+
v0.22.0

‎v0.22.0/_action_8h_source.html‎

Lines changed: 217 additions & 0 deletions
Large diffs are not rendered by default.

‎v0.22.0/_activities_8h_source.html‎

Lines changed: 676 additions & 0 deletions
Large diffs are not rendered by default.

‎v0.22.0/_activity_8h_source.html‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.3"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Gamedev Framework (gf): Activity.h Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/x-mathjax-config">
13+
MathJax.Hub.Config({
14+
extensions: ["tex2jax.js"],
15+
jax: ["input/TeX","output/HTML-CSS"],
16+
});
17+
</script>
18+
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
<link href="custom.css" rel="stylesheet" type="text/css"/>
21+
</head>
22+
<body>
23+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
24+
<div id="titlearea">
25+
<table cellspacing="0" cellpadding="0">
26+
<tbody>
27+
<tr id="projectrow">
28+
<td id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
29+
<td id="projectalign">
30+
<div id="projectname">Gamedev Framework (gf)<span id="projectnumber">&#160;0.22.0</span>
31+
</div>
32+
<div id="projectbrief">A C++17 framework for 2D games</div>
33+
</td>
34+
</tr>
35+
</tbody>
36+
</table>
37+
</div>
38+
<!-- end header part -->
39+
<!-- Generated by Doxygen 1.9.3 -->
40+
<script type="text/javascript" src="menudata.js"></script>
41+
<script type="text/javascript" src="menu.js"></script>
42+
<script type="text/javascript">
43+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
44+
$(function() {
45+
initMenu('',false,false,'search.php','Search');
46+
});
47+
/* @license-end */
48+
</script>
49+
<div id="main-nav"></div>
50+
<div id="nav-path" class="navpath">
51+
<ul>
52+
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
53+
</div>
54+
</div><!-- top -->
55+
<div class="header">
56+
<div class="headertitle"><div class="title">Activity.h</div></div>
57+
</div><!--header-->
58+
<div class="contents">
59+
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
60+
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Gamedev Framework (gf)</span></div>
61+
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (C) 2016-2022 Julien Bernard</span></div>
62+
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
63+
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This software is provided &#39;as-is&#39;, without any express or implied</span></div>
64+
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div>
65+
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * arising from the use of this software.</span></div>
66+
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
67+
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div>
68+
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div>
69+
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * freely, subject to the following restrictions:</span></div>
70+
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div>
71+
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div>
72+
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * claim that you wrote the original software. If you use this software</span></div>
73+
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div>
74+
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * appreciated but is not required.</span></div>
75+
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div>
76+
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * misrepresented as being the original software.</span></div>
77+
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div>
78+
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> */</span></div>
79+
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifndef GF_ACTIVITY_H</span></div>
80+
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define GF_ACTIVITY_H</span></div>
81+
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
82+
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &quot;CoreApi.h&quot;</span></div>
83+
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &quot;Time.h&quot;</span></div>
84+
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
85+
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegf.html">gf</a> {</div>
86+
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
87+
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div>
88+
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#endif</span></div>
89+
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
90+
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="group__core__animation.html#gac51a053dba8754067dd4bbbf793754df"> 38</a></span> <span class="keyword">enum class</span> <a class="code hl_enumeration" href="group__core__animation.html#gac51a053dba8754067dd4bbbf793754df">ActivityStatus</a> {</div>
91+
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_enumvalue" href="group__core__animation.html#ggac51a053dba8754067dd4bbbf793754dfa5bda814c4aedb126839228f1a3d92f09">Running</a>, </div>
92+
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_enumvalue" href="group__core__animation.html#ggac51a053dba8754067dd4bbbf793754dfa8f3d10eb21bd36347c258679eba9e92b">Finished</a>, </div>
93+
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> };</div>
94+
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
95+
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classgf_1_1_activity.html"> 62</a></span> <span class="keyword">class </span>GF_CORE_API <a class="code hl_class" href="classgf_1_1_activity.html">Activity</a> {</div>
96+
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">public</span>:</div>
97+
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classgf_1_1_activity.html#a541a05bc394bc48e1a6f38f91959f2b0"> 67</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classgf_1_1_activity.html#a541a05bc394bc48e1a6f38f91959f2b0">~Activity</a>();</div>
98+
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
99+
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classgf_1_1_activity.html#a0299bd0365cbf50648135bf3d6d406d0"> 75</a></span> <span class="keyword">virtual</span> <a class="code hl_enumeration" href="group__core__animation.html#gac51a053dba8754067dd4bbbf793754df">ActivityStatus</a> <a class="code hl_function" href="classgf_1_1_activity.html#a0299bd0365cbf50648135bf3d6d406d0">run</a>(<a class="code hl_class" href="classgf_1_1_time.html">Time</a> time) = 0;</div>
100+
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
101+
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="classgf_1_1_activity.html#a9bd70c04b696b39d2e5d2ecb84a07a87"> 80</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgf_1_1_activity.html#a9bd70c04b696b39d2e5d2ecb84a07a87">restart</a>();</div>
102+
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> };</div>
103+
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
104+
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
105+
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span>}</div>
106+
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="preprocessor">#endif</span></div>
107+
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>}</div>
108+
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
109+
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="preprocessor">#endif </span><span class="comment">// GF_ACTIVITY_H</span></div>
110+
<div class="ttc" id="aclassgf_1_1_activity_html"><div class="ttname"><a href="classgf_1_1_activity.html">gf::Activity</a></div><div class="ttdoc">A game activity.</div><div class="ttdef"><b>Definition:</b> Activity.h:62</div></div>
111+
<div class="ttc" id="aclassgf_1_1_activity_html_a0299bd0365cbf50648135bf3d6d406d0"><div class="ttname"><a href="classgf_1_1_activity.html#a0299bd0365cbf50648135bf3d6d406d0">gf::Activity::run</a></div><div class="ttdeci">virtual ActivityStatus run(Time time)=0</div><div class="ttdoc">Run the activity.</div></div>
112+
<div class="ttc" id="aclassgf_1_1_activity_html_a541a05bc394bc48e1a6f38f91959f2b0"><div class="ttname"><a href="classgf_1_1_activity.html#a541a05bc394bc48e1a6f38f91959f2b0">gf::Activity::~Activity</a></div><div class="ttdeci">virtual ~Activity()</div><div class="ttdoc">Destructor.</div></div>
113+
<div class="ttc" id="aclassgf_1_1_activity_html_a9bd70c04b696b39d2e5d2ecb84a07a87"><div class="ttname"><a href="classgf_1_1_activity.html#a9bd70c04b696b39d2e5d2ecb84a07a87">gf::Activity::restart</a></div><div class="ttdeci">virtual void restart()</div><div class="ttdoc">Restart the activity.</div></div>
114+
<div class="ttc" id="aclassgf_1_1_time_html"><div class="ttname"><a href="classgf_1_1_time.html">gf::Time</a></div><div class="ttdoc">Represents a time value.</div><div class="ttdef"><b>Definition:</b> Time.h:65</div></div>
115+
<div class="ttc" id="agroup__core__animation_html_gac51a053dba8754067dd4bbbf793754df"><div class="ttname"><a href="group__core__animation.html#gac51a053dba8754067dd4bbbf793754df">gf::ActivityStatus</a></div><div class="ttdeci">ActivityStatus</div><div class="ttdoc">Status of an activity.</div><div class="ttdef"><b>Definition:</b> Activity.h:38</div></div>
116+
<div class="ttc" id="agroup__core__animation_html_ggac51a053dba8754067dd4bbbf793754dfa5bda814c4aedb126839228f1a3d92f09"><div class="ttname"><a href="group__core__animation.html#ggac51a053dba8754067dd4bbbf793754dfa5bda814c4aedb126839228f1a3d92f09">gf::ActivityStatus::Running</a></div><div class="ttdeci">@ Running</div><div class="ttdoc">The activity is still running.</div></div>
117+
<div class="ttc" id="agroup__core__animation_html_ggac51a053dba8754067dd4bbbf793754dfa8f3d10eb21bd36347c258679eba9e92b"><div class="ttname"><a href="group__core__animation.html#ggac51a053dba8754067dd4bbbf793754dfa8f3d10eb21bd36347c258679eba9e92b">gf::ActivityStatus::Finished</a></div><div class="ttdeci">@ Finished</div><div class="ttdoc">The activity is finished.</div></div>
118+
<div class="ttc" id="anamespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes.</div></div>
119+
</div><!-- fragment --></div><!-- contents -->
120+
<!-- start footer part -->
121+
<hr class="footer"/><address class="footer"><small>
122+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
123+
</small></address>
124+
</body>
125+
</html>

0 commit comments

Comments
 (0)