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
319
320
321
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libg3d-context">
<refmeta>
<refentrytitle role="top_of_page" id="libg3d-context.top_of_page">context</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBG3D Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>context</refname>
<refpurpose>Libg3d initialization and configuration</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libg3d-context.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <g3d/g3d.h>
<link linkend="G3DContext">G3DContext</link>;
<link linkend="G3DContext">G3DContext</link>* <link linkend="g3d-context-new">g3d_context_new</link> (void);
<link linkend="void">void</link> <link linkend="g3d-context-free">g3d_context_free</link> (<link linkend="G3DContext">G3DContext</link> *context);
<link linkend="gboolean">gboolean</link> (<link linkend="G3DSetBgColorFunc">*G3DSetBgColorFunc</link>) (<link linkend="G3DFloat">G3DFloat</link> r,
<link linkend="G3DFloat">G3DFloat</link> g,
<link linkend="G3DFloat">G3DFloat</link> b,
<link linkend="G3DFloat">G3DFloat</link> a,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> (<link linkend="G3DUpdateInterfaceFunc">*G3DUpdateInterfaceFunc</link>) (<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> (<link linkend="G3DUpdateProgressBarFunc">*G3DUpdateProgressBarFunc</link>) (<link linkend="G3DFloat">G3DFloat</link> percentage,
<link linkend="gboolean">gboolean</link> show,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-context-update-interface">g3d_context_update_interface</link> (<link linkend="G3DContext">G3DContext</link> *context);
<link linkend="void">void</link> <link linkend="g3d-context-set-update-interface-func">g3d_context_set_update_interface_func</link>
(<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DUpdateInterfaceFunc">G3DUpdateInterfaceFunc</link> func,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-context-update-progress-bar">g3d_context_update_progress_bar</link> (<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DFloat">G3DFloat</link> percentage,
<link linkend="gboolean">gboolean</link> visibility);
<link linkend="void">void</link> <link linkend="g3d-context-set-update-progress-bar-func">g3d_context_set_update_progress_bar_func</link>
(<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DUpdateProgressBarFunc">G3DUpdateProgressBarFunc</link> func,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-context-set-bgcolor">g3d_context_set_bgcolor</link> (<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DFloat">G3DFloat</link> r,
<link linkend="G3DFloat">G3DFloat</link> g,
<link linkend="G3DFloat">G3DFloat</link> b,
<link linkend="G3DFloat">G3DFloat</link> a);
<link linkend="void">void</link> <link linkend="g3d-context-set-set-bgcolor-func">g3d_context_set_set_bgcolor_func</link> (<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DSetBgColorFunc">G3DSetBgColorFunc</link> func,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libg3d-context.description" role="desc">
<title role="desc.title">Description</title>
<para>
All state information is saved in the context. It also serves as an
interface to the application.</para>
<para>
</para>
</refsect1>
<refsect1 id="libg3d-context.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="G3DContext" role="struct">
<title>G3DContext</title>
<indexterm zone="G3DContext"><primary>G3DContext</primary></indexterm><programlisting>typedef struct {
} G3DContext;
</programlisting>
<para>
Internal stuff for libg3d.</para>
<para>
</para></refsect2>
<refsect2 id="g3d-context-new" role="function">
<title>g3d_context_new ()</title>
<indexterm zone="g3d-context-new"><primary>g3d_context_new</primary></indexterm><programlisting><link linkend="G3DContext">G3DContext</link>* g3d_context_new (void);</programlisting>
<para>
Create a new context. This initializes the library (and also the
plugin system so this has not to be done seperately).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a valid context, or NULL on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-context-free" role="function">
<title>g3d_context_free ()</title>
<indexterm zone="g3d-context-free"><primary>g3d_context_free</primary></indexterm><programlisting><link linkend="void">void</link> g3d_context_free (<link linkend="G3DContext">G3DContext</link> *context);</programlisting>
<para>
Cleans up the context and the plugin system and frees all reserved
memory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> the context to free
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="G3DSetBgColorFunc" role="function">
<title>G3DSetBgColorFunc ()</title>
<indexterm zone="G3DSetBgColorFunc"><primary>G3DSetBgColorFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*G3DSetBgColorFunc) (<link linkend="G3DFloat">G3DFloat</link> r,
<link linkend="G3DFloat">G3DFloat</link> g,
<link linkend="G3DFloat">G3DFloat</link> b,
<link linkend="G3DFloat">G3DFloat</link> a,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Background color setting callback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>r</parameter> :</term>
<listitem><simpara> red component
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>g</parameter> :</term>
<listitem><simpara> green component
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>b</parameter> :</term>
<listitem><simpara> blue component
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>a</parameter> :</term>
<listitem><simpara> alpha component
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> opaque data as given to <link linkend="g3d-context-set-set-bgcolor-func"><function>g3d_context_set_set_bgcolor_func()</function></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="G3DUpdateInterfaceFunc" role="function">
<title>G3DUpdateInterfaceFunc ()</title>
<indexterm zone="G3DUpdateInterfaceFunc"><primary>G3DUpdateInterfaceFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*G3DUpdateInterfaceFunc) (<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Interface updating callback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> opaque data as given to <link linkend="g3d-context-set-update-interface-func"><function>g3d_context_set_update_interface_func()</function></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="G3DUpdateProgressBarFunc" role="function">
<title>G3DUpdateProgressBarFunc ()</title>
<indexterm zone="G3DUpdateProgressBarFunc"><primary>G3DUpdateProgressBarFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*G3DUpdateProgressBarFunc) (<link linkend="G3DFloat">G3DFloat</link> percentage,
<link linkend="gboolean">gboolean</link> show,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Progress updating callback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>percentage</parameter> :</term>
<listitem><simpara> progress of plugin operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>show</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if the progress bar should be visible, <link linkend="FALSE:CAPS"><type>FALSE</type></link> else
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> opaque data as given to
<link linkend="g3d-context-set-update-progress-bar-func"><function>g3d_context_set_update_progress_bar_func()</function></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-context-update-interface" role="function">
<title>g3d_context_update_interface ()</title>
<indexterm zone="g3d-context-update-interface"><primary>g3d_context_update_interface</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_context_update_interface (<link linkend="G3DContext">G3DContext</link> *context);</programlisting>
<para>
Try to update the interface. This will call a function registered with
<parameter>g3d_context_set_update_interface_func</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> a valid context
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-context-set-update-interface-func" role="function">
<title>g3d_context_set_update_interface_func ()</title>
<indexterm zone="g3d-context-set-update-interface-func"><primary>g3d_context_set_update_interface_func</primary></indexterm><programlisting><link linkend="void">void</link> g3d_context_set_update_interface_func
(<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DUpdateInterfaceFunc">G3DUpdateInterfaceFunc</link> func,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Registers a callback function for updating the interface.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> a valid context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter> :</term>
<listitem><simpara> the callback function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> user-defined opaque pointer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-context-update-progress-bar" role="function">
<title>g3d_context_update_progress_bar ()</title>
<indexterm zone="g3d-context-update-progress-bar"><primary>g3d_context_update_progress_bar</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_context_update_progress_bar (<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DFloat">G3DFloat</link> percentage,
<link linkend="gboolean">gboolean</link> visibility);</programlisting>
<para>
Try to update the progress bar.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> a valid context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>percentage</parameter> :</term>
<listitem><simpara> the percentage to set on the progress bar
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>visibility</parameter> :</term>
<listitem><simpara> show or hide the progress bar
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-context-set-update-progress-bar-func" role="function">
<title>g3d_context_set_update_progress_bar_func ()</title>
<indexterm zone="g3d-context-set-update-progress-bar-func"><primary>g3d_context_set_update_progress_bar_func</primary></indexterm><programlisting><link linkend="void">void</link> g3d_context_set_update_progress_bar_func
(<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DUpdateProgressBarFunc">G3DUpdateProgressBarFunc</link> func,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Registers a callback function for updating the progress bar.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> a valid context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter> :</term>
<listitem><simpara> the callback function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> user-defined opaque pointer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-context-set-bgcolor" role="function">
<title>g3d_context_set_bgcolor ()</title>
<indexterm zone="g3d-context-set-bgcolor"><primary>g3d_context_set_bgcolor</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_context_set_bgcolor (<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DFloat">G3DFloat</link> r,
<link linkend="G3DFloat">G3DFloat</link> g,
<link linkend="G3DFloat">G3DFloat</link> b,
<link linkend="G3DFloat">G3DFloat</link> a);</programlisting>
<para>
Try to set the background color. This will call a function registered
with <link><parameter>g3d_context_set_set_bgcolor_func</parameter></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> a valid context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>r</parameter> :</term>
<listitem><simpara> red component (range: 0.0 .. 1.0)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>g</parameter> :</term>
<listitem><simpara> green component (range: 0.0 .. 1.0)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>b</parameter> :</term>
<listitem><simpara> green component (range: 0.0 .. 1.0)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>a</parameter> :</term>
<listitem><simpara> alpha component
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-context-set-set-bgcolor-func" role="function">
<title>g3d_context_set_set_bgcolor_func ()</title>
<indexterm zone="g3d-context-set-set-bgcolor-func"><primary>g3d_context_set_set_bgcolor_func</primary></indexterm><programlisting><link linkend="void">void</link> g3d_context_set_set_bgcolor_func (<link linkend="G3DContext">G3DContext</link> *context,
<link linkend="G3DSetBgColorFunc">G3DSetBgColorFunc</link> func,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Registers a callback function for setting the background color.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> a valid context
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter> :</term>
<listitem><simpara> the callback function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> user-defined opaque pointer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="libg3d-context.see-also">
<title>See Also</title>
<link linkend="G3DContext"><type>G3DContext</type></link>
</refsect1>
</refentry>
|
