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
|
<!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"/>
<title>AllegroGL: Core routines</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="alleggl.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">AllegroGL <span id="projectnumber">0.4.4</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('group__core.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Core routines</h1> </div>
</div>
<div class="contents">
<p>Basic AllegroGL functions.
<a href="#_details">More...</a></p>
<h2><a name="func-members"></a>
Functions</h2>
<ul>
<li>int <a class="el" href="group__core.html#gaa0cbb82fa1e2bae6788eb7bd06673bd3">install_allegro_gl</a> (void)
<dl class="el"><dd class="mdescRight">Installs the AllegroGL addon to Allegro. <a href="#gaa0cbb82fa1e2bae6788eb7bd06673bd3"></a><br/></dl><li>void <a class="el" href="group__core.html#gaeff6abbb1d1071a01f4cd694ef504298">remove_allegro_gl</a> (void)
<dl class="el"><dd class="mdescRight">Removes the AllegroGL addon. <a href="#gaeff6abbb1d1071a01f4cd694ef504298"></a><br/></dl><li>void <a class="el" href="group__core.html#gaf5aad043e99b766393fa4a7ec034a0f1">allegro_gl_flip</a> (void)
<dl class="el"><dd class="mdescRight">Flips the front and back framebuffers. <a href="#gaf5aad043e99b766393fa4a7ec034a0f1"></a><br/></dl><li>float <a class="el" href="group__core.html#ga444d507eaeb5ba800787f6a81827615d">allegro_gl_opengl_version</a> ()
<dl class="el"><dd class="mdescRight">Returns the OpenGL version number of the client (the computer the program is running on). <a href="#ga444d507eaeb5ba800787f6a81827615d"></a><br/></dl></ul>
<h2><a name="member-group"></a>
Core Functions</h2>
<ul>
<li>#define <a class="el" href="group__core.html#ga59b02f9584f81789449a7fcc2018bfc5">allegro_gl_begin</a>()   ;
<dl class="el"><dd class="mdescRight">Backward compatibility #define for programs written prior to AGL 0.0.22. <a href="#ga59b02f9584f81789449a7fcc2018bfc5"></a><br/></dl><li>#define <a class="el" href="group__core.html#gac1303e0363f3adfc33c8812e9b8e30b0">allegro_gl_end</a>()   ;
<dl class="el"><dd class="mdescRight">Backward compatibility #define for programs written prior to AGL 0.0.22. <a href="#gac1303e0363f3adfc33c8812e9b8e30b0"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Basic AllegroGL functions. </p>
<p>These functions allow you to initialize AllegroGL, set up a rendering context via set_gfx_mode(), and allow access to regular OpenGL functions. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga59b02f9584f81789449a7fcc2018bfc5"></a><!-- doxytag: member="alleggl.h::allegro_gl_begin" ref="ga59b02f9584f81789449a7fcc2018bfc5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define allegro_gl_begin</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   ;</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Backward compatibility #define for programs written prior to AGL 0.0.22. </p>
<p>It isn't defined as anything meaningful, so you don't need to put them in your program.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__core.html#gac1303e0363f3adfc33c8812e9b8e30b0" title="Backward compatibility #define for programs written prior to AGL 0.0.22.">allegro_gl_end()</a> </dd></dl>
<p>Definition at line <a class="el" href="alleggl_8h_source.html#l00166">166</a> of file <a class="el" href="alleggl_8h_source.html">alleggl.h</a>.</p>
</div>
</div>
<a class="anchor" id="gac1303e0363f3adfc33c8812e9b8e30b0"></a><!-- doxytag: member="alleggl.h::allegro_gl_end" ref="gac1303e0363f3adfc33c8812e9b8e30b0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define allegro_gl_end</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   ;</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Backward compatibility #define for programs written prior to AGL 0.0.22. </p>
<p>It isn't defined as anything meaningful, so you don't need to put them in your program.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__core.html#ga59b02f9584f81789449a7fcc2018bfc5" title="Backward compatibility #define for programs written prior to AGL 0.0.22.">allegro_gl_begin()</a> </dd></dl>
<p>Definition at line <a class="el" href="alleggl_8h_source.html#l00176">176</a> of file <a class="el" href="alleggl_8h_source.html">alleggl.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa0cbb82fa1e2bae6788eb7bd06673bd3"></a><!-- doxytag: member="alleggl.c::install_allegro_gl" ref="gaa0cbb82fa1e2bae6788eb7bd06673bd3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int install_allegro_gl </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Installs the AllegroGL addon to Allegro. </p>
<p>Allegro should already be initialized with allegro_init() or install_allegro().</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success; -1 on failure.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__core.html#gaeff6abbb1d1071a01f4cd694ef504298" title="Removes the AllegroGL addon.">remove_allegro_gl()</a> </dd></dl>
<p>Definition at line <a class="el" href="alleggl_8c_source.html#l00836">836</a> of file <a class="el" href="alleggl_8c_source.html">alleggl.c</a>.</p>
<p>References <a class="el" href="alleggl_8c_source.html#l00193">allegro_gl_clear_settings()</a>, and <a class="el" href="alleggl_8c_source.html#l00894">remove_allegro_gl()</a>.</p>
</div>
</div>
<a class="anchor" id="gaeff6abbb1d1071a01f4cd694ef504298"></a><!-- doxytag: member="alleggl.c::remove_allegro_gl" ref="gaeff6abbb1d1071a01f4cd694ef504298" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void remove_allegro_gl </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the AllegroGL addon. </p>
<p>You should not call any more OpenGL or AllegroGL functions after calling this function. Note that it will be called automatically at program exit, so you don't need to explicitly do it.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__core.html#gaa0cbb82fa1e2bae6788eb7bd06673bd3" title="Installs the AllegroGL addon to Allegro.">install_allegro_gl()</a> </dd></dl>
<p>Definition at line <a class="el" href="alleggl_8c_source.html#l00894">894</a> of file <a class="el" href="alleggl_8c_source.html">alleggl.c</a>.</p>
<p>Referenced by <a class="el" href="alleggl_8c_source.html#l00836">install_allegro_gl()</a>.</p>
</div>
</div>
<a class="anchor" id="gaf5aad043e99b766393fa4a7ec034a0f1"></a><!-- doxytag: member="alleggl.c::allegro_gl_flip" ref="gaf5aad043e99b766393fa4a7ec034a0f1" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void allegro_gl_flip </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flips the front and back framebuffers. </p>
<p>If you chose, or were given, a double buffered OpenGL mode, you have access to a front buffer, which is visible on the screen, and also a back buffer, which is not visible. This routine flips the buffers, so that the contents of the back buffer is now the contents of the (visible) front buffer. The contents of the backbuffer is undefined after the operation.</p>
<p>Normally in these modes you would do all your drawing to the back buffer, without the user seeing the image while it's partially drawn, and then call this function to flip the buffers, allowing the user to see what you've drawn, now that it's finished, while you proceed to draw the next frame.</p>
<p>When drawing to the screen bitmap, you may not be drawing to what user currently sees on his monitor. It is recommended that you rebuild the screen every frame, then flip, then draw again.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__settings.html#ga025e79a4394803a0e15aaf07b1a8a656" title="Sets a configuration option.">allegro_gl_set()</a>, <a class="el" href="group__settings.html#gaa1150ae35d6ff9b33d5771f29f9770dd" title="Creates a backbuffer if set.">AGL_DOUBLEBUFFER</a> </dd></dl>
<p>Definition at line <a class="el" href="alleggl_8c_source.html#l00951">951</a> of file <a class="el" href="alleggl_8c_source.html">alleggl.c</a>.</p>
<p>Referenced by <a class="el" href="gui_8c_source.html#l00111">algl_popup_dialog()</a>, and <a class="el" href="gui_8c_source.html#l00477">d_algl_viewport_proc()</a>.</p>
</div>
</div>
<a class="anchor" id="ga444d507eaeb5ba800787f6a81827615d"></a><!-- doxytag: member="alleggl.c::allegro_gl_opengl_version" ref="ga444d507eaeb5ba800787f6a81827615d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float allegro_gl_opengl_version </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the OpenGL version number of the client (the computer the program is running on). </p>
<p>"1.0" is returned as 1.0, "1.2.1" is returned as 1.21, and "1.2.2" as 1.22, etc.</p>
<p>A valid OpenGL context must exist for this function to work, which means you may <b>not</b> call it before set_gfx_mode(GFX_OPENGL)</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The OpenGL ICD/MCD version number. </dd></dl>
<p>Definition at line <a class="el" href="alleggl_8c_source.html#l00971">971</a> of file <a class="el" href="alleggl_8c_source.html">alleggl.c</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="footer">Generated on Thu May 19 2011 23:20:20 for AllegroGL by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
|
