diff options
Diffstat (limited to 'src/others/mimesh/libg3d-0.0.8/doc/api/xml/plugins.xml')
-rw-r--r-- | src/others/mimesh/libg3d-0.0.8/doc/api/xml/plugins.xml | 423 |
1 files changed, 423 insertions, 0 deletions
diff --git a/src/others/mimesh/libg3d-0.0.8/doc/api/xml/plugins.xml b/src/others/mimesh/libg3d-0.0.8/doc/api/xml/plugins.xml new file mode 100644 index 0000000..567293e --- /dev/null +++ b/src/others/mimesh/libg3d-0.0.8/doc/api/xml/plugins.xml | |||
@@ -0,0 +1,423 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> | ||
4 | <refentry id="libg3d-plugins"> | ||
5 | <refmeta> | ||
6 | <refentrytitle role="top_of_page" id="libg3d-plugins.top_of_page">plugins</refentrytitle> | ||
7 | <manvolnum>3</manvolnum> | ||
8 | <refmiscinfo>LIBG3D Library</refmiscinfo> | ||
9 | </refmeta> | ||
10 | |||
11 | <refnamediv> | ||
12 | <refname>plugins</refname> | ||
13 | <refpurpose>G3DPlugin interface</refpurpose> | ||
14 | <!--[<xref linkend="desc" endterm="desc.title"/>]--> | ||
15 | </refnamediv> | ||
16 | |||
17 | <refsynopsisdiv id="libg3d-plugins.synopsis" role="synopsis"> | ||
18 | <title role="synopsis.title">Synopsis</title> | ||
19 | |||
20 | <synopsis> | ||
21 | |||
22 | #include <g3d/plugins.h> | ||
23 | |||
24 | enum <link linkend="G3DPluginType">G3DPluginType</link>; | ||
25 | <link linkend="gpointer">gpointer</link> (<link linkend="G3DPluginInitFunc">*G3DPluginInitFunc</link>) (<link linkend="G3DContext">G3DContext</link> *context); | ||
26 | <link linkend="void">void</link> (<link linkend="G3DPluginCleanupFunc">*G3DPluginCleanupFunc</link>) (<link linkend="gpointer">gpointer</link> user_data); | ||
27 | <link linkend="gboolean">gboolean</link> (<link linkend="G3DPluginLoadModelFunc">*G3DPluginLoadModelFunc</link>) (<link linkend="G3DContext">G3DContext</link> *context, | ||
28 | const <link linkend="gchar">gchar</link> *filename, | ||
29 | <link linkend="G3DModel">G3DModel</link> *model, | ||
30 | <link linkend="gpointer">gpointer</link> user_data); | ||
31 | <link linkend="gboolean">gboolean</link> (<link linkend="G3DPluginLoadModelFromStreamFunc">*G3DPluginLoadModelFromStreamFunc</link>) (<link linkend="G3DContext">G3DContext</link> *context, | ||
32 | <link linkend="G3DStream">G3DStream</link> *stream, | ||
33 | <link linkend="G3DModel">G3DModel</link> *model, | ||
34 | <link linkend="gpointer">gpointer</link> user_data); | ||
35 | <link linkend="gboolean">gboolean</link> (<link linkend="G3DPluginLoadImageFunc">*G3DPluginLoadImageFunc</link>) (<link linkend="G3DContext">G3DContext</link> *context, | ||
36 | const <link linkend="gchar">gchar</link> *filename, | ||
37 | <link linkend="G3DImage">G3DImage</link> *image, | ||
38 | <link linkend="gpointer">gpointer</link> user_data); | ||
39 | <link linkend="gboolean">gboolean</link> (<link linkend="G3DPluginLoadImageStreamFunc">*G3DPluginLoadImageStreamFunc</link>) (<link linkend="G3DContext">G3DContext</link> *context, | ||
40 | <link linkend="G3DStream">G3DStream</link> *stream, | ||
41 | <link linkend="G3DImage">G3DImage</link> *image, | ||
42 | <link linkend="gpointer">gpointer</link> user_data); | ||
43 | <link linkend="gchar">gchar</link>* (<link linkend="G3DPluginGetDescFunc">*G3DPluginGetDescFunc</link>) (<link linkend="G3DContext">G3DContext</link> *context); | ||
44 | <link linkend="gchar">gchar</link>** (<link linkend="G3DPluginGetExtFunc">*G3DPluginGetExtFunc</link>) (<link linkend="G3DContext">G3DContext</link> *context); | ||
45 | <link linkend="G3DPlugin">G3DPlugin</link>; | ||
46 | <link linkend="gboolean">gboolean</link> <link linkend="g3d-plugins-init">g3d_plugins_init</link> (<link linkend="G3DContext">G3DContext</link> *context); | ||
47 | <link linkend="void">void</link> <link linkend="g3d-plugins-cleanup">g3d_plugins_cleanup</link> (<link linkend="G3DContext">G3DContext</link> *context); | ||
48 | <link linkend="gboolean">gboolean</link> <link linkend="g3d-plugins-load-model">g3d_plugins_load_model</link> (<link linkend="G3DContext">G3DContext</link> *context, | ||
49 | const <link linkend="gchar">gchar</link> *filename, | ||
50 | <link linkend="G3DModel">G3DModel</link> *model); | ||
51 | <link linkend="gboolean">gboolean</link> <link linkend="g3d-plugins-load-model-from-stream">g3d_plugins_load_model_from_stream</link> (<link linkend="G3DContext">G3DContext</link> *context, | ||
52 | <link linkend="G3DStream">G3DStream</link> *stream, | ||
53 | <link linkend="G3DModel">G3DModel</link> *model); | ||
54 | <link linkend="gboolean">gboolean</link> <link linkend="g3d-plugins-load-image">g3d_plugins_load_image</link> (<link linkend="G3DContext">G3DContext</link> *context, | ||
55 | const <link linkend="gchar">gchar</link> *filename, | ||
56 | <link linkend="G3DImage">G3DImage</link> *image); | ||
57 | <link linkend="gboolean">gboolean</link> <link linkend="g3d-plugins-load-image-from-stream">g3d_plugins_load_image_from_stream</link> (<link linkend="G3DContext">G3DContext</link> *context, | ||
58 | <link linkend="G3DStream">G3DStream</link> *stream, | ||
59 | <link linkend="G3DImage">G3DImage</link> *image); | ||
60 | <link linkend="gchar">gchar</link>** <link linkend="g3d-plugins-get-image-extensions">g3d_plugins_get_image_extensions</link> (<link linkend="G3DContext">G3DContext</link> *context); | ||
61 | </synopsis> | ||
62 | </refsynopsisdiv> | ||
63 | |||
64 | |||
65 | |||
66 | |||
67 | |||
68 | |||
69 | |||
70 | |||
71 | |||
72 | <refsect1 id="libg3d-plugins.description" role="desc"> | ||
73 | <title role="desc.title">Description</title> | ||
74 | <para> | ||
75 | Direct interaction with the plugin system is normally not needed when using | ||
76 | libg3d. It may be required when writing a plugin which should load a | ||
77 | <link linkend="G3DImage"><type>G3DImage</type></link> or a <link linkend="G3DModel"><type>G3DModel</type></link> with another plugin.</para> | ||
78 | <para> | ||
79 | |||
80 | </para> | ||
81 | </refsect1> | ||
82 | |||
83 | <refsect1 id="libg3d-plugins.details" role="details"> | ||
84 | <title role="details.title">Details</title> | ||
85 | <refsect2 id="G3DPluginType" role="enum"> | ||
86 | <title>enum G3DPluginType</title> | ||
87 | <indexterm zone="G3DPluginType"><primary>G3DPluginType</primary></indexterm><programlisting>typedef enum { | ||
88 | G3D_PLUGIN_UNKNOWN = 0x00, | ||
89 | G3D_PLUGIN_IMPORT, | ||
90 | G3D_PLUGIN_IMAGE | ||
91 | } G3DPluginType; | ||
92 | </programlisting> | ||
93 | <para> | ||
94 | Type of plugin.</para> | ||
95 | <para> | ||
96 | |||
97 | </para><variablelist role="enum"> | ||
98 | <varlistentry id="G3D-PLUGIN-UNKNOWN:CAPS" role="constant"> | ||
99 | <term><literal>G3D_PLUGIN_UNKNOWN</literal></term> | ||
100 | <listitem><simpara> unknown plugin type | ||
101 | </simpara></listitem> | ||
102 | </varlistentry> | ||
103 | <varlistentry id="G3D-PLUGIN-IMPORT:CAPS" role="constant"> | ||
104 | <term><literal>G3D_PLUGIN_IMPORT</literal></term> | ||
105 | <listitem><simpara> model import plugin | ||
106 | </simpara></listitem> | ||
107 | </varlistentry> | ||
108 | <varlistentry id="G3D-PLUGIN-IMAGE:CAPS" role="constant"> | ||
109 | <term><literal>G3D_PLUGIN_IMAGE</literal></term> | ||
110 | <listitem><simpara> image loading plugin | ||
111 | </simpara></listitem> | ||
112 | </varlistentry> | ||
113 | </variablelist></refsect2> | ||
114 | <refsect2 id="G3DPluginInitFunc" role="function"> | ||
115 | <title>G3DPluginInitFunc ()</title> | ||
116 | <indexterm zone="G3DPluginInitFunc"><primary>G3DPluginInitFunc</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link> (*G3DPluginInitFunc) (<link linkend="G3DContext">G3DContext</link> *context);</programlisting> | ||
117 | <para> | ||
118 | Prototype for <link linkend="plugin-init"><function>plugin_init()</function></link>.</para> | ||
119 | <para> | ||
120 | |||
121 | </para><variablelist role="params"> | ||
122 | <varlistentry><term><parameter>context</parameter> :</term> | ||
123 | <listitem><simpara> the context | ||
124 | </simpara></listitem></varlistentry> | ||
125 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> opaque plugin data. | ||
126 | </simpara></listitem></varlistentry> | ||
127 | </variablelist></refsect2> | ||
128 | <refsect2 id="G3DPluginCleanupFunc" role="function"> | ||
129 | <title>G3DPluginCleanupFunc ()</title> | ||
130 | <indexterm zone="G3DPluginCleanupFunc"><primary>G3DPluginCleanupFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*G3DPluginCleanupFunc) (<link linkend="gpointer">gpointer</link> user_data);</programlisting> | ||
131 | <para> | ||
132 | Prototype for <link linkend="plugin-cleanup"><function>plugin_cleanup()</function></link>.</para> | ||
133 | <para> | ||
134 | |||
135 | </para><variablelist role="params"> | ||
136 | <varlistentry><term><parameter>user_data</parameter> :</term> | ||
137 | <listitem><simpara> opaque plugin data | ||
138 | </simpara></listitem></varlistentry> | ||
139 | </variablelist></refsect2> | ||
140 | <refsect2 id="G3DPluginLoadModelFunc" role="function"> | ||
141 | <title>G3DPluginLoadModelFunc ()</title> | ||
142 | <indexterm zone="G3DPluginLoadModelFunc"><primary>G3DPluginLoadModelFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*G3DPluginLoadModelFunc) (<link linkend="G3DContext">G3DContext</link> *context, | ||
143 | const <link linkend="gchar">gchar</link> *filename, | ||
144 | <link linkend="G3DModel">G3DModel</link> *model, | ||
145 | <link linkend="gpointer">gpointer</link> user_data);</programlisting> | ||
146 | <para> | ||
147 | Prototype for <link linkend="plugin-load-model"><function>plugin_load_model()</function></link>.</para> | ||
148 | <para> | ||
149 | |||
150 | </para><variablelist role="params"> | ||
151 | <varlistentry><term><parameter>context</parameter> :</term> | ||
152 | <listitem><simpara> the context | ||
153 | </simpara></listitem></varlistentry> | ||
154 | <varlistentry><term><parameter>filename</parameter> :</term> | ||
155 | <listitem><simpara> file name of model | ||
156 | </simpara></listitem></varlistentry> | ||
157 | <varlistentry><term><parameter>model</parameter> :</term> | ||
158 | <listitem><simpara> the model structure to fill | ||
159 | </simpara></listitem></varlistentry> | ||
160 | <varlistentry><term><parameter>user_data</parameter> :</term> | ||
161 | <listitem><simpara> opaque plugin data | ||
162 | </simpara></listitem></varlistentry> | ||
163 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
164 | </simpara></listitem></varlistentry> | ||
165 | </variablelist></refsect2> | ||
166 | <refsect2 id="G3DPluginLoadModelFromStreamFunc" role="function"> | ||
167 | <title>G3DPluginLoadModelFromStreamFunc ()</title> | ||
168 | <indexterm zone="G3DPluginLoadModelFromStreamFunc"><primary>G3DPluginLoadModelFromStreamFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*G3DPluginLoadModelFromStreamFunc) (<link linkend="G3DContext">G3DContext</link> *context, | ||
169 | <link linkend="G3DStream">G3DStream</link> *stream, | ||
170 | <link linkend="G3DModel">G3DModel</link> *model, | ||
171 | <link linkend="gpointer">gpointer</link> user_data);</programlisting> | ||
172 | <para> | ||
173 | Prototype for <link linkend="plugin-load-model-from-stream"><function>plugin_load_model_from_stream()</function></link>.</para> | ||
174 | <para> | ||
175 | |||
176 | </para><variablelist role="params"> | ||
177 | <varlistentry><term><parameter>context</parameter> :</term> | ||
178 | <listitem><simpara> the context | ||
179 | </simpara></listitem></varlistentry> | ||
180 | <varlistentry><term><parameter>stream</parameter> :</term> | ||
181 | <listitem><simpara> the stream to load from | ||
182 | </simpara></listitem></varlistentry> | ||
183 | <varlistentry><term><parameter>model</parameter> :</term> | ||
184 | <listitem><simpara> the model structure to fill | ||
185 | </simpara></listitem></varlistentry> | ||
186 | <varlistentry><term><parameter>user_data</parameter> :</term> | ||
187 | <listitem><simpara> opaque plugin data | ||
188 | </simpara></listitem></varlistentry> | ||
189 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
190 | </simpara></listitem></varlistentry> | ||
191 | </variablelist></refsect2> | ||
192 | <refsect2 id="G3DPluginLoadImageFunc" role="function"> | ||
193 | <title>G3DPluginLoadImageFunc ()</title> | ||
194 | <indexterm zone="G3DPluginLoadImageFunc"><primary>G3DPluginLoadImageFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*G3DPluginLoadImageFunc) (<link linkend="G3DContext">G3DContext</link> *context, | ||
195 | const <link linkend="gchar">gchar</link> *filename, | ||
196 | <link linkend="G3DImage">G3DImage</link> *image, | ||
197 | <link linkend="gpointer">gpointer</link> user_data);</programlisting> | ||
198 | <para> | ||
199 | Prototype for <link linkend="plugin-load-image"><function>plugin_load_image()</function></link>.</para> | ||
200 | <para> | ||
201 | |||
202 | </para><variablelist role="params"> | ||
203 | <varlistentry><term><parameter>context</parameter> :</term> | ||
204 | <listitem><simpara> the context | ||
205 | </simpara></listitem></varlistentry> | ||
206 | <varlistentry><term><parameter>filename</parameter> :</term> | ||
207 | <listitem><simpara> file name of image | ||
208 | </simpara></listitem></varlistentry> | ||
209 | <varlistentry><term><parameter>image</parameter> :</term> | ||
210 | <listitem><simpara> image structure to fill | ||
211 | </simpara></listitem></varlistentry> | ||
212 | <varlistentry><term><parameter>user_data</parameter> :</term> | ||
213 | <listitem><simpara> opaque plugin data | ||
214 | </simpara></listitem></varlistentry> | ||
215 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
216 | </simpara></listitem></varlistentry> | ||
217 | </variablelist></refsect2> | ||
218 | <refsect2 id="G3DPluginLoadImageStreamFunc" role="function"> | ||
219 | <title>G3DPluginLoadImageStreamFunc ()</title> | ||
220 | <indexterm zone="G3DPluginLoadImageStreamFunc"><primary>G3DPluginLoadImageStreamFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*G3DPluginLoadImageStreamFunc) (<link linkend="G3DContext">G3DContext</link> *context, | ||
221 | <link linkend="G3DStream">G3DStream</link> *stream, | ||
222 | <link linkend="G3DImage">G3DImage</link> *image, | ||
223 | <link linkend="gpointer">gpointer</link> user_data);</programlisting> | ||
224 | <para> | ||
225 | Prototype for <link linkend="plugin-load-image-from-stream"><function>plugin_load_image_from_stream()</function></link>.</para> | ||
226 | <para> | ||
227 | |||
228 | </para><variablelist role="params"> | ||
229 | <varlistentry><term><parameter>context</parameter> :</term> | ||
230 | <listitem><simpara> the context | ||
231 | </simpara></listitem></varlistentry> | ||
232 | <varlistentry><term><parameter>stream</parameter> :</term> | ||
233 | <listitem><simpara> the stream to load from | ||
234 | </simpara></listitem></varlistentry> | ||
235 | <varlistentry><term><parameter>image</parameter> :</term> | ||
236 | <listitem><simpara> image structure to fill | ||
237 | </simpara></listitem></varlistentry> | ||
238 | <varlistentry><term><parameter>user_data</parameter> :</term> | ||
239 | <listitem><simpara> opaque plugin data | ||
240 | </simpara></listitem></varlistentry> | ||
241 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
242 | </simpara></listitem></varlistentry> | ||
243 | </variablelist></refsect2> | ||
244 | <refsect2 id="G3DPluginGetDescFunc" role="function"> | ||
245 | <title>G3DPluginGetDescFunc ()</title> | ||
246 | <indexterm zone="G3DPluginGetDescFunc"><primary>G3DPluginGetDescFunc</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* (*G3DPluginGetDescFunc) (<link linkend="G3DContext">G3DContext</link> *context);</programlisting> | ||
247 | <para> | ||
248 | Prototype for <link linkend="plugin-description"><function>plugin_description()</function></link>.</para> | ||
249 | <para> | ||
250 | |||
251 | </para><variablelist role="params"> | ||
252 | <varlistentry><term><parameter>context</parameter> :</term> | ||
253 | <listitem><simpara> the context | ||
254 | </simpara></listitem></varlistentry> | ||
255 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly-allocated string containing the description of the plugin. | ||
256 | </simpara></listitem></varlistentry> | ||
257 | </variablelist></refsect2> | ||
258 | <refsect2 id="G3DPluginGetExtFunc" role="function"> | ||
259 | <title>G3DPluginGetExtFunc ()</title> | ||
260 | <indexterm zone="G3DPluginGetExtFunc"><primary>G3DPluginGetExtFunc</primary></indexterm><programlisting><link linkend="gchar">gchar</link>** (*G3DPluginGetExtFunc) (<link linkend="G3DContext">G3DContext</link> *context);</programlisting> | ||
261 | <para> | ||
262 | Prototype for <link linkend="plugin-extensions"><function>plugin_extensions()</function></link>.</para> | ||
263 | <para> | ||
264 | |||
265 | </para><variablelist role="params"> | ||
266 | <varlistentry><term><parameter>context</parameter> :</term> | ||
267 | <listitem><simpara> the context | ||
268 | </simpara></listitem></varlistentry> | ||
269 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> NULL-terminated list of file extensions supported by this plugin. | ||
270 | Free with <link linkend="g-strfreev"><function>g_strfreev()</function></link>. | ||
271 | </simpara></listitem></varlistentry> | ||
272 | </variablelist></refsect2> | ||
273 | <refsect2 id="G3DPlugin" role="struct"> | ||
274 | <title>G3DPlugin</title> | ||
275 | <indexterm zone="G3DPlugin"><primary>G3DPlugin</primary></indexterm><programlisting>typedef struct { | ||
276 | } G3DPlugin; | ||
277 | </programlisting> | ||
278 | <para> | ||
279 | A libg3d plugin.</para> | ||
280 | <para> | ||
281 | |||
282 | </para></refsect2> | ||
283 | <refsect2 id="g3d-plugins-init" role="function"> | ||
284 | <title>g3d_plugins_init ()</title> | ||
285 | <indexterm zone="g3d-plugins-init"><primary>g3d_plugins_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_plugins_init (<link linkend="G3DContext">G3DContext</link> *context);</programlisting> | ||
286 | <para> | ||
287 | Initializes the plugin system. This is implicitly done when using | ||
288 | <link linkend="g3d-context-new"><function>g3d_context_new()</function></link>.</para> | ||
289 | <para> | ||
290 | |||
291 | </para><variablelist role="params"> | ||
292 | <varlistentry><term><parameter>context</parameter> :</term> | ||
293 | <listitem><simpara> a valid <link linkend="G3DContext"><type>G3DContext</type></link> | ||
294 | </simpara></listitem></varlistentry> | ||
295 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
296 | </simpara></listitem></varlistentry> | ||
297 | </variablelist></refsect2> | ||
298 | <refsect2 id="g3d-plugins-cleanup" role="function"> | ||
299 | <title>g3d_plugins_cleanup ()</title> | ||
300 | <indexterm zone="g3d-plugins-cleanup"><primary>g3d_plugins_cleanup</primary></indexterm><programlisting><link linkend="void">void</link> g3d_plugins_cleanup (<link linkend="G3DContext">G3DContext</link> *context);</programlisting> | ||
301 | <para> | ||
302 | Clean up the plugin system. Usually done by <link linkend="g3d-context-free"><function>g3d_context_free()</function></link>.</para> | ||
303 | <para> | ||
304 | |||
305 | </para><variablelist role="params"> | ||
306 | <varlistentry><term><parameter>context</parameter> :</term> | ||
307 | <listitem><simpara> a valid context | ||
308 | </simpara></listitem></varlistentry> | ||
309 | </variablelist></refsect2> | ||
310 | <refsect2 id="g3d-plugins-load-model" role="function"> | ||
311 | <title>g3d_plugins_load_model ()</title> | ||
312 | <indexterm zone="g3d-plugins-load-model"><primary>g3d_plugins_load_model</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_plugins_load_model (<link linkend="G3DContext">G3DContext</link> *context, | ||
313 | const <link linkend="gchar">gchar</link> *filename, | ||
314 | <link linkend="G3DModel">G3DModel</link> *model);</programlisting> | ||
315 | <para> | ||
316 | Try to load a model from file using import plugins.</para> | ||
317 | <para> | ||
318 | |||
319 | </para><variablelist role="params"> | ||
320 | <varlistentry><term><parameter>context</parameter> :</term> | ||
321 | <listitem><simpara> a valid context | ||
322 | </simpara></listitem></varlistentry> | ||
323 | <varlistentry><term><parameter>filename</parameter> :</term> | ||
324 | <listitem><simpara> file name of model to load | ||
325 | </simpara></listitem></varlistentry> | ||
326 | <varlistentry><term><parameter>model</parameter> :</term> | ||
327 | <listitem><simpara> model structure to fill | ||
328 | </simpara></listitem></varlistentry> | ||
329 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
330 | </simpara></listitem></varlistentry> | ||
331 | </variablelist></refsect2> | ||
332 | <refsect2 id="g3d-plugins-load-model-from-stream" role="function"> | ||
333 | <title>g3d_plugins_load_model_from_stream ()</title> | ||
334 | <indexterm zone="g3d-plugins-load-model-from-stream"><primary>g3d_plugins_load_model_from_stream</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_plugins_load_model_from_stream (<link linkend="G3DContext">G3DContext</link> *context, | ||
335 | <link linkend="G3DStream">G3DStream</link> *stream, | ||
336 | <link linkend="G3DModel">G3DModel</link> *model);</programlisting> | ||
337 | <para> | ||
338 | Try to load a model from stream using import plugins.</para> | ||
339 | <para> | ||
340 | |||
341 | </para><variablelist role="params"> | ||
342 | <varlistentry><term><parameter>context</parameter> :</term> | ||
343 | <listitem><simpara> a valid context | ||
344 | </simpara></listitem></varlistentry> | ||
345 | <varlistentry><term><parameter>stream</parameter> :</term> | ||
346 | <listitem><simpara> stream to load model from | ||
347 | </simpara></listitem></varlistentry> | ||
348 | <varlistentry><term><parameter>model</parameter> :</term> | ||
349 | <listitem><simpara> model structure to fill | ||
350 | </simpara></listitem></varlistentry> | ||
351 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
352 | </simpara></listitem></varlistentry> | ||
353 | </variablelist></refsect2> | ||
354 | <refsect2 id="g3d-plugins-load-image" role="function"> | ||
355 | <title>g3d_plugins_load_image ()</title> | ||
356 | <indexterm zone="g3d-plugins-load-image"><primary>g3d_plugins_load_image</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_plugins_load_image (<link linkend="G3DContext">G3DContext</link> *context, | ||
357 | const <link linkend="gchar">gchar</link> *filename, | ||
358 | <link linkend="G3DImage">G3DImage</link> *image);</programlisting> | ||
359 | <para> | ||
360 | Try to load an image from file using import plugins.</para> | ||
361 | <para> | ||
362 | |||
363 | </para><variablelist role="params"> | ||
364 | <varlistentry><term><parameter>context</parameter> :</term> | ||
365 | <listitem><simpara> a valid context | ||
366 | </simpara></listitem></varlistentry> | ||
367 | <varlistentry><term><parameter>filename</parameter> :</term> | ||
368 | <listitem><simpara> file name of image to load | ||
369 | </simpara></listitem></varlistentry> | ||
370 | <varlistentry><term><parameter>image</parameter> :</term> | ||
371 | <listitem><simpara> image structure to fill | ||
372 | </simpara></listitem></varlistentry> | ||
373 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
374 | </simpara></listitem></varlistentry> | ||
375 | </variablelist></refsect2> | ||
376 | <refsect2 id="g3d-plugins-load-image-from-stream" role="function"> | ||
377 | <title>g3d_plugins_load_image_from_stream ()</title> | ||
378 | <indexterm zone="g3d-plugins-load-image-from-stream"><primary>g3d_plugins_load_image_from_stream</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_plugins_load_image_from_stream (<link linkend="G3DContext">G3DContext</link> *context, | ||
379 | <link linkend="G3DStream">G3DStream</link> *stream, | ||
380 | <link linkend="G3DImage">G3DImage</link> *image);</programlisting> | ||
381 | <para> | ||
382 | Try to load an image from stream using import plugins.</para> | ||
383 | <para> | ||
384 | |||
385 | </para><variablelist role="params"> | ||
386 | <varlistentry><term><parameter>context</parameter> :</term> | ||
387 | <listitem><simpara> a valid context | ||
388 | </simpara></listitem></varlistentry> | ||
389 | <varlistentry><term><parameter>stream</parameter> :</term> | ||
390 | <listitem><simpara> stream to load image from | ||
391 | </simpara></listitem></varlistentry> | ||
392 | <varlistentry><term><parameter>image</parameter> :</term> | ||
393 | <listitem><simpara> image structure to fill | ||
394 | </simpara></listitem></varlistentry> | ||
395 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else. | ||
396 | </simpara></listitem></varlistentry> | ||
397 | </variablelist></refsect2> | ||
398 | <refsect2 id="g3d-plugins-get-image-extensions" role="function"> | ||
399 | <title>g3d_plugins_get_image_extensions ()</title> | ||
400 | <indexterm zone="g3d-plugins-get-image-extensions"><primary>g3d_plugins_get_image_extensions</primary></indexterm><programlisting><link linkend="gchar">gchar</link>** g3d_plugins_get_image_extensions (<link linkend="G3DContext">G3DContext</link> *context);</programlisting> | ||
401 | <para> | ||
402 | Get the supported image type extensions.</para> | ||
403 | <para> | ||
404 | |||
405 | </para><variablelist role="params"> | ||
406 | <varlistentry><term><parameter>context</parameter> :</term> | ||
407 | <listitem><simpara> a valid context | ||
408 | </simpara></listitem></varlistentry> | ||
409 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> NULL-terminated list of image file extensions supported by this | ||
410 | plugin. Free with <link linkend="g-strfreev"><function>g_strfreev()</function></link>. | ||
411 | </simpara></listitem></varlistentry> | ||
412 | </variablelist></refsect2> | ||
413 | |||
414 | </refsect1> | ||
415 | |||
416 | |||
417 | |||
418 | <refsect1 id="libg3d-plugins.see-also"> | ||
419 | <title>See Also</title> | ||
420 | <link linkend="G3DPlugin"><type>G3DPlugin</type></link> | ||
421 | </refsect1> | ||
422 | |||
423 | </refentry> | ||