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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>renderingMode</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="ch03.html" title="OpenGL tools">
<link rel="prev" href="ch03.html" title="OpenGL tools">
<link rel="next" href="v-sim-light.html" title="light">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-light.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-renderingMode.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-renderingMode.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="renderingMode">
<a name="v-sim-renderingMode"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-renderingMode.top_of_page"></a>renderingMode</span></h2>
<p>renderingMode — Controls the way OpenGL renders objects.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-renderingMode.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId">VisuRenderingModeId</a>;
<span class="returnvalue">void</span> <a class="link" href="v-sim-renderingMode.html#openGLInit-renderingMode" title="openGLInit_renderingMode ()">openGLInit_renderingMode</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-renderingMode.html#openGLSet-globalRenderingMode" title="openGLSet_globalRenderingMode ()">openGLSet_globalRenderingMode</a> (<em class="parameter"><code><a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId"><span class="type">VisuRenderingModeId</span></a> value</code></em>);
<a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId"><span class="returnvalue">VisuRenderingModeId</span></a> <a class="link" href="v-sim-renderingMode.html#openGLGet-globalRenderingOption" title="openGLGet_globalRenderingOption ()">openGLGet_globalRenderingOption</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-renderingMode.html#openGLGet-renderingFromName" title="openGLGet_renderingFromName ()">openGLGet_renderingFromName</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId"><span class="type">VisuRenderingModeId</span></a> *id</code></em>);
const <span class="returnvalue">char</span>** <a class="link" href="v-sim-renderingMode.html#openGLGet-allRenderingModes" title="openGLGet_allRenderingModes ()">openGLGet_allRenderingModes</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">char</span>** <a class="link" href="v-sim-renderingMode.html#openGLGet-allRenderingModesI18n" title="openGLGet_allRenderingModesI18n ()">openGLGet_allRenderingModesI18n</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-renderingMode.html#openGLApply-renderingMode" title="openGLApply_renderingMode ()">openGLApply_renderingMode</a> (<em class="parameter"><code><a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId"><span class="type">VisuRenderingModeId</span></a> mode</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-renderingMode.description"></a><h2>Description</h2>
<p>
</p>
<p>
This modules creates an interface to access to the way OpenGL
renders the objects (<code class="function">glPolygonMode()</code> and <code class="function">glShadeModel()</code>
functions). There are then three rendering modes available in
V_Sim: wireframe, flat and smooth. They are controls by an enum
<a href="v-sim-renderingMode.html#RenderingModeId"><span class="type">RenderingModeId</span></a>. When <a class="link" href="v-sim-renderingMode.html#openGLApply-renderingMode" title="openGLApply_renderingMode ()"><code class="function">openGLApply_renderingMode()</code></a> is called, the
current rendering mode is changed for all future drawing calls that
uses polygons.
</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-renderingMode.details"></a><h2>Details</h2>
<div class="refsect2" title="enum VisuRenderingModeId">
<a name="VisuRenderingModeId"></a><h3>enum VisuRenderingModeId</h3>
<pre class="programlisting">typedef enum
{
Wireframe,
Flat,
Smooth,
SmoothAndEdge,
nb_renderingModes,
followGeneralSetting
} VisuRenderingModeId;
</pre>
<p>
Implemented mode to draw objects.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="Wireframe"></a><span class="term"><code class="literal">Wireframe</code></span></p></td>
<td>objects are rendered with lines only ;
</td>
</tr>
<tr>
<td><p><a name="Flat"></a><span class="term"><code class="literal">Flat</code></span></p></td>
<td>objects are rendered with polygons whose colours are uniform
on each polygon ;
</td>
</tr>
<tr>
<td><p><a name="Smooth"></a><span class="term"><code class="literal">Smooth</code></span></p></td>
<td>objects are rendered with polygons whose colours
are shaded to be smooth all along the object.
</td>
</tr>
<tr>
<td><p><a name="SmoothAndEdge"></a><span class="term"><code class="literal">SmoothAndEdge</code></span></p></td>
<td>objects are rendered with lines hightlighting the
contours of polygons.
</td>
</tr>
<tr>
<td><p><a name="nb-renderingModes"></a><span class="term"><code class="literal">nb_renderingModes</code></span></p></td>
<td>number of rendering mode.
</td>
</tr>
<tr>
<td><p><a name="followGeneralSetting"></a><span class="term"><code class="literal">followGeneralSetting</code></span></p></td>
<td>use this value not to choose any rendering mode.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="openGLInit_renderingMode ()">
<a name="openGLInit-renderingMode"></a><h3>openGLInit_renderingMode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> openGLInit_renderingMode (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method is used by opengl.c to initialise this module (declare config file
options...). It should not be called elsewhere.
</p>
</div>
<hr>
<div class="refsect2" title="openGLSet_globalRenderingMode ()">
<a name="openGLSet-globalRenderingMode"></a><h3>openGLSet_globalRenderingMode ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> openGLSet_globalRenderingMode (<em class="parameter"><code><a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId"><span class="type">VisuRenderingModeId</span></a> value</code></em>);</pre>
<p>
This function change the value of the parameter renderingOption.
It controls how V_Sim renders objects, in wireframe for example.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>an integer to represent the method of rendering.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the signal OpenGLAskForReDraw should be emitted.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="openGLGet_globalRenderingOption ()">
<a name="openGLGet-globalRenderingOption"></a><h3>openGLGet_globalRenderingOption ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId"><span class="returnvalue">VisuRenderingModeId</span></a> openGLGet_globalRenderingOption (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function retrieve the value of the parameter renderingOption.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the identifier of the current rendering option.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="openGLGet_renderingFromName ()">
<a name="openGLGet-renderingFromName"></a><h3>openGLGet_renderingFromName ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> openGLGet_renderingFromName (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId"><span class="type">VisuRenderingModeId</span></a> *id</code></em>);</pre>
<p>
This function retrieve the rendering mode id associated to the name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a string ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>a location to store the resulting id.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the name exists.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="openGLGet_allRenderingModes ()">
<a name="openGLGet-allRenderingModes"></a><h3>openGLGet_allRenderingModes ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span>** openGLGet_allRenderingModes (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function retrieve al the names of available rendering modes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an array of string, NULL terminated that is private (not to be freed).
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="openGLGet_allRenderingModesI18n ()">
<a name="openGLGet-allRenderingModesI18n"></a><h3>openGLGet_allRenderingModesI18n ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span>** openGLGet_allRenderingModesI18n (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function retrieve al the names (translated) of available rendering modes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an array of string, NULL terminated that is private (not to be freed).
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="openGLApply_renderingMode ()">
<a name="openGLApply-renderingMode"></a><h3>openGLApply_renderingMode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> openGLApply_renderingMode (<em class="parameter"><code><a class="link" href="v-sim-renderingMode.html#VisuRenderingModeId" title="enum VisuRenderingModeId"><span class="type">VisuRenderingModeId</span></a> mode</code></em>);</pre>
<p>
Change the rendering mode of current OpenGL context.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>an integer.
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
