1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
<!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>SDL2_gfx: /cygdrive/i/Sources/sdl2gfx/SDL2_framerate.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="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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SDL2_gfx
 <span id="projectnumber">1.0.2</span>
</div>
<div id="projectbrief">GraphicsprimitivesandsurfacefunctionsforSDL2</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">/cygdrive/i/Sources/sdl2gfx/SDL2_framerate.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "SDL.h"</code><br />
</div>
<p><a href="_s_d_l2__framerate_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure holding the state and timing information of the framerate controller. <a href="struct_f_p_smanager.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aeaeac0f0b439344496e29abf60904d58"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#aeaeac0f0b439344496e29abf60904d58">FPS_UPPER_LIMIT</a>   200</td></tr>
<tr class="memdesc:aeaeac0f0b439344496e29abf60904d58"><td class="mdescLeft"> </td><td class="mdescRight">Highest possible rate supported by framerate controller in Hz (1/s). <a href="#aeaeac0f0b439344496e29abf60904d58">More...</a><br /></td></tr>
<tr class="separator:aeaeac0f0b439344496e29abf60904d58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9555dceeaaffdd2669c991e6a300085b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#a9555dceeaaffdd2669c991e6a300085b">FPS_LOWER_LIMIT</a>   1</td></tr>
<tr class="memdesc:a9555dceeaaffdd2669c991e6a300085b"><td class="mdescLeft"> </td><td class="mdescRight">Lowest possible rate supported by framerate controller in Hz (1/s). <a href="#a9555dceeaaffdd2669c991e6a300085b">More...</a><br /></td></tr>
<tr class="separator:a9555dceeaaffdd2669c991e6a300085b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3ac02e6acb348129a019b9f20aa5c90"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#ab3ac02e6acb348129a019b9f20aa5c90">FPS_DEFAULT</a>   30</td></tr>
<tr class="memdesc:ab3ac02e6acb348129a019b9f20aa5c90"><td class="mdescLeft"> </td><td class="mdescRight">Default rate of framerate controller in Hz (1/s). <a href="#ab3ac02e6acb348129a019b9f20aa5c90">More...</a><br /></td></tr>
<tr class="separator:ab3ac02e6acb348129a019b9f20aa5c90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0b200240224bd14f4d63d0491176abe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a>   extern</td></tr>
<tr class="separator:af0b200240224bd14f4d63d0491176abe"><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:a843f0672446aff01ef03bbcd977fbedf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#a843f0672446aff01ef03bbcd977fbedf">SDL_initFramerate</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr>
<tr class="memdesc:a843f0672446aff01ef03bbcd977fbedf"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the framerate manager. <a href="#a843f0672446aff01ef03bbcd977fbedf">More...</a><br /></td></tr>
<tr class="separator:a843f0672446aff01ef03bbcd977fbedf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2f7f11e60d81489392707faf07c5ac5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#aa2f7f11e60d81489392707faf07c5ac5">SDL_setFramerate</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager, Uint32 rate)</td></tr>
<tr class="memdesc:aa2f7f11e60d81489392707faf07c5ac5"><td class="mdescLeft"> </td><td class="mdescRight">Set the framerate in Hz. <a href="#aa2f7f11e60d81489392707faf07c5ac5">More...</a><br /></td></tr>
<tr class="separator:aa2f7f11e60d81489392707faf07c5ac5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebe43457dbb9fbfec6de18e7adf49e21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#aebe43457dbb9fbfec6de18e7adf49e21">SDL_getFramerate</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr>
<tr class="memdesc:aebe43457dbb9fbfec6de18e7adf49e21"><td class="mdescLeft"> </td><td class="mdescRight">Return the current target framerate in Hz. <a href="#aebe43457dbb9fbfec6de18e7adf49e21">More...</a><br /></td></tr>
<tr class="separator:aebe43457dbb9fbfec6de18e7adf49e21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41de3f516b9633f102d7ba2e85d2bb98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#a41de3f516b9633f102d7ba2e85d2bb98">SDL_getFramecount</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr>
<tr class="memdesc:a41de3f516b9633f102d7ba2e85d2bb98"><td class="mdescLeft"> </td><td class="mdescRight">Return the current framecount. <a href="#a41de3f516b9633f102d7ba2e85d2bb98">More...</a><br /></td></tr>
<tr class="separator:a41de3f516b9633f102d7ba2e85d2bb98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc3b999d59d913771cd2588299096274"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> Uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="_s_d_l2__framerate_8h.html#afc3b999d59d913771cd2588299096274">SDL_framerateDelay</a> (<a class="el" href="struct_f_p_smanager.html">FPSmanager</a> *manager)</td></tr>
<tr class="memdesc:afc3b999d59d913771cd2588299096274"><td class="mdescLeft"> </td><td class="mdescRight">Delay execution to maintain a constant framerate and calculate fps. <a href="#afc3b999d59d913771cd2588299096274">More...</a><br /></td></tr>
<tr class="separator:afc3b999d59d913771cd2588299096274"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ab3ac02e6acb348129a019b9f20aa5c90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FPS_DEFAULT   30</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default rate of framerate controller in Hz (1/s). </p>
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8h_source.html#l00057">57</a> of file <a class="el" href="_s_d_l2__framerate_8h_source.html">SDL2_framerate.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9555dceeaaffdd2669c991e6a300085b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FPS_LOWER_LIMIT   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Lowest possible rate supported by framerate controller in Hz (1/s). </p>
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8h_source.html#l00052">52</a> of file <a class="el" href="_s_d_l2__framerate_8h_source.html">SDL2_framerate.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeaeac0f0b439344496e29abf60904d58"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FPS_UPPER_LIMIT   200</td>
</tr>
</table>
</div><div class="memdoc">
<p>Highest possible rate supported by framerate controller in Hz (1/s). </p>
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8h_source.html#l00047">47</a> of file <a class="el" href="_s_d_l2__framerate_8h_source.html">SDL2_framerate.h</a>.</p>
</div>
</div>
<a class="anchor" id="af0b200240224bd14f4d63d0491176abe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDL2_FRAMERATE_SCOPE   extern</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8h_source.html#l00082">82</a> of file <a class="el" href="_s_d_l2__framerate_8h_source.html">SDL2_framerate.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="afc3b999d59d913771cd2588299096274"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> Uint32 SDL_framerateDelay </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td>
<td class="paramname"><em>manager</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delay execution to maintain a constant framerate and calculate fps. </p>
<p>Generate a delay to accomodate currently set framerate. Call once in the graphics/rendering loop. If the computer cannot keep up with the rate (i.e. drawing too slow), the delay is zero and the delay interpolation is reset.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">manager</td><td>Pointer to the framerate manager.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The time that passed since the last call to the function in ms. May return 0. </dd></dl>
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8c_source.html#l00146">146</a> of file <a class="el" href="_s_d_l2__framerate_8c_source.html">SDL2_framerate.c</a>.</p>
</div>
</div>
<a class="anchor" id="a41de3f516b9633f102d7ba2e85d2bb98"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int SDL_getFramecount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td>
<td class="paramname"><em>manager</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current framecount. </p>
<p>Get the current framecount from the framerate manager. A frame is counted each time SDL_framerateDelay is called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">manager</td><td>Pointer to the framerate manager.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current frame count or -1 for error. </dd></dl>
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8c_source.html#l00126">126</a> of file <a class="el" href="_s_d_l2__framerate_8c_source.html">SDL2_framerate.c</a>.</p>
</div>
</div>
<a class="anchor" id="aebe43457dbb9fbfec6de18e7adf49e21"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int SDL_getFramerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td>
<td class="paramname"><em>manager</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current target framerate in Hz. </p>
<p>Get the currently set framerate of the manager.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">manager</td><td>Pointer to the framerate manager.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current framerate in Hz or -1 for error. </dd></dl>
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8c_source.html#l00107">107</a> of file <a class="el" href="_s_d_l2__framerate_8c_source.html">SDL2_framerate.c</a>.</p>
</div>
</div>
<a class="anchor" id="a843f0672446aff01ef03bbcd977fbedf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> void SDL_initFramerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td>
<td class="paramname"><em>manager</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the framerate manager. </p>
<p>Initialize the framerate manager, set default framerate of 30Hz and reset delay interpolation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">manager</td><td>Pointer to the framerate manager. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8c_source.html#l00062">62</a> of file <a class="el" href="_s_d_l2__framerate_8c_source.html">SDL2_framerate.c</a>.</p>
</div>
</div>
<a class="anchor" id="aa2f7f11e60d81489392707faf07c5ac5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_s_d_l2__framerate_8h.html#af0b200240224bd14f4d63d0491176abe">SDL2_FRAMERATE_SCOPE</a> int SDL_setFramerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_f_p_smanager.html">FPSmanager</a> * </td>
<td class="paramname"><em>manager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 </td>
<td class="paramname"><em>rate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the framerate in Hz. </p>
<p>Sets a new framerate for the manager and reset delay interpolation. Rate values must be between FPS_LOWER_LIMIT and FPS_UPPER_LIMIT inclusive to be accepted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">manager</td><td>Pointer to the framerate manager. </td></tr>
<tr><td class="paramname">rate</td><td>The new framerate in Hz (frames per second).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for sucess and -1 for error. </dd></dl>
<p>Definition at line <a class="el" href="_s_d_l2__framerate_8c_source.html#l00086">86</a> of file <a class="el" href="_s_d_l2__framerate_8c_source.html">SDL2_framerate.c</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
|
