diff options
Diffstat (limited to 'src/others/mimesh/libg3d-0.0.8/doc/api/tmpl/stream.sgml')
-rw-r--r-- | src/others/mimesh/libg3d-0.0.8/doc/api/tmpl/stream.sgml | 391 |
1 files changed, 391 insertions, 0 deletions
diff --git a/src/others/mimesh/libg3d-0.0.8/doc/api/tmpl/stream.sgml b/src/others/mimesh/libg3d-0.0.8/doc/api/tmpl/stream.sgml new file mode 100644 index 0000000..c487c34 --- /dev/null +++ b/src/others/mimesh/libg3d-0.0.8/doc/api/tmpl/stream.sgml | |||
@@ -0,0 +1,391 @@ | |||
1 | <!-- ##### SECTION Title ##### --> | ||
2 | stream | ||
3 | |||
4 | <!-- ##### SECTION Short_Description ##### --> | ||
5 | |||
6 | |||
7 | <!-- ##### SECTION Long_Description ##### --> | ||
8 | <para> | ||
9 | |||
10 | </para> | ||
11 | |||
12 | <!-- ##### SECTION See_Also ##### --> | ||
13 | <para> | ||
14 | |||
15 | </para> | ||
16 | |||
17 | <!-- ##### SECTION Stability_Level ##### --> | ||
18 | |||
19 | |||
20 | <!-- ##### STRUCT G3DStream ##### --> | ||
21 | <para> | ||
22 | |||
23 | </para> | ||
24 | |||
25 | |||
26 | <!-- ##### FUNCTION g3d_stream_open_file ##### --> | ||
27 | <para> | ||
28 | |||
29 | </para> | ||
30 | |||
31 | @filename: | ||
32 | @mode: | ||
33 | @Returns: | ||
34 | |||
35 | |||
36 | <!-- ##### FUNCTION g3d_stream_open_structured_file ##### --> | ||
37 | <para> | ||
38 | |||
39 | </para> | ||
40 | |||
41 | @filename: | ||
42 | @subfile: | ||
43 | @Returns: | ||
44 | |||
45 | |||
46 | <!-- ##### FUNCTION g3d_stream_open_structured_file_from_stream ##### --> | ||
47 | <para> | ||
48 | |||
49 | </para> | ||
50 | |||
51 | @stream: | ||
52 | @subfile: | ||
53 | @Returns: | ||
54 | |||
55 | |||
56 | <!-- ##### FUNCTION g3d_stream_open_zip ##### --> | ||
57 | <para> | ||
58 | |||
59 | </para> | ||
60 | |||
61 | @filename: | ||
62 | @subfile: | ||
63 | @Returns: | ||
64 | |||
65 | |||
66 | <!-- ##### FUNCTION g3d_stream_open_zip_from_stream ##### --> | ||
67 | <para> | ||
68 | |||
69 | </para> | ||
70 | |||
71 | @stream: | ||
72 | @subfile: | ||
73 | @Returns: | ||
74 | |||
75 | |||
76 | <!-- ##### FUNCTION g3d_stream_open_gzip_from_stream ##### --> | ||
77 | <para> | ||
78 | |||
79 | </para> | ||
80 | |||
81 | @stream: | ||
82 | @Returns: | ||
83 | |||
84 | |||
85 | <!-- ##### FUNCTION g3d_stream_from_buffer ##### --> | ||
86 | <para> | ||
87 | |||
88 | </para> | ||
89 | |||
90 | @buffer: | ||
91 | @size: | ||
92 | @title: | ||
93 | @free_buffer: | ||
94 | @Returns: | ||
95 | |||
96 | |||
97 | <!-- ##### FUNCTION g3d_stream_zlib_inflate_stream ##### --> | ||
98 | <para> | ||
99 | |||
100 | </para> | ||
101 | |||
102 | @stream: | ||
103 | @cmp_size: | ||
104 | @Returns: | ||
105 | |||
106 | |||
107 | <!-- ##### FUNCTION g3d_stream_new_custom ##### --> | ||
108 | <para> | ||
109 | |||
110 | </para> | ||
111 | |||
112 | @flags: | ||
113 | @uri: | ||
114 | @readfunc: | ||
115 | @readlinefunc: | ||
116 | @seekfunc: | ||
117 | @tellfunc: | ||
118 | @sizefunc: | ||
119 | @eoffunc: | ||
120 | @closefunc: | ||
121 | @data: | ||
122 | @Returns: | ||
123 | |||
124 | |||
125 | <!-- ##### FUNCTION g3d_stream_close ##### --> | ||
126 | <para> | ||
127 | |||
128 | </para> | ||
129 | |||
130 | @stream: | ||
131 | @Returns: | ||
132 | |||
133 | |||
134 | <!-- ##### FUNCTION g3d_stream_skip ##### --> | ||
135 | <para> | ||
136 | |||
137 | </para> | ||
138 | |||
139 | @stream: | ||
140 | @offset: | ||
141 | @Returns: | ||
142 | |||
143 | |||
144 | <!-- ##### FUNCTION g3d_stream_seek ##### --> | ||
145 | <para> | ||
146 | |||
147 | </para> | ||
148 | |||
149 | @stream: | ||
150 | @offset: | ||
151 | @whence: | ||
152 | @Returns: | ||
153 | |||
154 | |||
155 | <!-- ##### FUNCTION g3d_stream_tell ##### --> | ||
156 | <para> | ||
157 | |||
158 | </para> | ||
159 | |||
160 | @stream: | ||
161 | @Returns: | ||
162 | |||
163 | |||
164 | <!-- ##### FUNCTION g3d_stream_size ##### --> | ||
165 | <para> | ||
166 | |||
167 | </para> | ||
168 | |||
169 | @stream: | ||
170 | @Returns: | ||
171 | |||
172 | |||
173 | <!-- ##### FUNCTION g3d_stream_eof ##### --> | ||
174 | <para> | ||
175 | |||
176 | </para> | ||
177 | |||
178 | @stream: | ||
179 | @Returns: | ||
180 | |||
181 | |||
182 | <!-- ##### FUNCTION g3d_stream_is_seekable ##### --> | ||
183 | <para> | ||
184 | |||
185 | </para> | ||
186 | |||
187 | @stream: | ||
188 | @Returns: | ||
189 | |||
190 | |||
191 | <!-- ##### FUNCTION g3d_stream_get_uri ##### --> | ||
192 | <para> | ||
193 | |||
194 | </para> | ||
195 | |||
196 | @stream: | ||
197 | @Returns: | ||
198 | |||
199 | |||
200 | <!-- ##### FUNCTION g3d_stream_line ##### --> | ||
201 | <para> | ||
202 | |||
203 | </para> | ||
204 | |||
205 | @stream: | ||
206 | @Returns: | ||
207 | |||
208 | |||
209 | <!-- ##### FUNCTION g3d_stream_read ##### --> | ||
210 | <para> | ||
211 | |||
212 | </para> | ||
213 | |||
214 | @stream: | ||
215 | @ptr: | ||
216 | @size: | ||
217 | @Returns: | ||
218 | |||
219 | |||
220 | <!-- ##### FUNCTION g3d_stream_read_line ##### --> | ||
221 | <para> | ||
222 | |||
223 | </para> | ||
224 | |||
225 | @stream: | ||
226 | @buf: | ||
227 | @size: | ||
228 | @Returns: | ||
229 | |||
230 | |||
231 | <!-- ##### FUNCTION g3d_stream_read_int8 ##### --> | ||
232 | <para> | ||
233 | |||
234 | </para> | ||
235 | |||
236 | @stream: | ||
237 | @Returns: | ||
238 | |||
239 | |||
240 | <!-- ##### FUNCTION g3d_stream_read_int16_be ##### --> | ||
241 | <para> | ||
242 | |||
243 | </para> | ||
244 | |||
245 | @stream: | ||
246 | @Returns: | ||
247 | |||
248 | |||
249 | <!-- ##### FUNCTION g3d_stream_read_int16_le ##### --> | ||
250 | <para> | ||
251 | |||
252 | </para> | ||
253 | |||
254 | @stream: | ||
255 | @Returns: | ||
256 | |||
257 | |||
258 | <!-- ##### FUNCTION g3d_stream_read_int32_be ##### --> | ||
259 | <para> | ||
260 | |||
261 | </para> | ||
262 | |||
263 | @stream: | ||
264 | @Returns: | ||
265 | |||
266 | |||
267 | <!-- ##### FUNCTION g3d_stream_read_int32_le ##### --> | ||
268 | <para> | ||
269 | |||
270 | </para> | ||
271 | |||
272 | @stream: | ||
273 | @Returns: | ||
274 | |||
275 | |||
276 | <!-- ##### FUNCTION g3d_stream_read_float_be ##### --> | ||
277 | <para> | ||
278 | |||
279 | </para> | ||
280 | |||
281 | @stream: | ||
282 | @Returns: | ||
283 | |||
284 | |||
285 | <!-- ##### FUNCTION g3d_stream_read_float_le ##### --> | ||
286 | <para> | ||
287 | |||
288 | </para> | ||
289 | |||
290 | @stream: | ||
291 | @Returns: | ||
292 | |||
293 | |||
294 | <!-- ##### FUNCTION g3d_stream_read_double_be ##### --> | ||
295 | <para> | ||
296 | |||
297 | </para> | ||
298 | |||
299 | @stream: | ||
300 | @Returns: | ||
301 | |||
302 | |||
303 | <!-- ##### FUNCTION g3d_stream_read_double_le ##### --> | ||
304 | <para> | ||
305 | |||
306 | </para> | ||
307 | |||
308 | @stream: | ||
309 | @Returns: | ||
310 | |||
311 | |||
312 | <!-- ##### FUNCTION g3d_stream_read_cstr ##### --> | ||
313 | <para> | ||
314 | |||
315 | </para> | ||
316 | |||
317 | @stream: | ||
318 | @buffer: | ||
319 | @max_len: | ||
320 | @Returns: | ||
321 | |||
322 | |||
323 | <!-- ##### USER_FUNCTION G3DStreamCloseFunc ##### --> | ||
324 | <para> | ||
325 | |||
326 | </para> | ||
327 | |||
328 | @data: | ||
329 | @Returns: | ||
330 | |||
331 | |||
332 | <!-- ##### USER_FUNCTION G3DStreamEofFunc ##### --> | ||
333 | <para> | ||
334 | |||
335 | </para> | ||
336 | |||
337 | @data: | ||
338 | @Returns: | ||
339 | |||
340 | |||
341 | <!-- ##### USER_FUNCTION G3DStreamReadFunc ##### --> | ||
342 | <para> | ||
343 | |||
344 | </para> | ||
345 | |||
346 | @ptr: | ||
347 | @size: | ||
348 | @data: | ||
349 | @Returns: | ||
350 | |||
351 | |||
352 | <!-- ##### USER_FUNCTION G3DStreamReadLineFunc ##### --> | ||
353 | <para> | ||
354 | |||
355 | </para> | ||
356 | |||
357 | @buf: | ||
358 | @size: | ||
359 | @data: | ||
360 | @Returns: | ||
361 | |||
362 | |||
363 | <!-- ##### USER_FUNCTION G3DStreamSeekFunc ##### --> | ||
364 | <para> | ||
365 | |||
366 | </para> | ||
367 | |||
368 | @data: | ||
369 | @offset: | ||
370 | @whence: | ||
371 | @Returns: | ||
372 | |||
373 | |||
374 | <!-- ##### USER_FUNCTION G3DStreamSizeFunc ##### --> | ||
375 | <para> | ||
376 | |||
377 | </para> | ||
378 | |||
379 | @data: | ||
380 | @Returns: | ||
381 | |||
382 | |||
383 | <!-- ##### USER_FUNCTION G3DStreamTellFunc ##### --> | ||
384 | <para> | ||
385 | |||
386 | </para> | ||
387 | |||
388 | @data: | ||
389 | @Returns: | ||
390 | |||
391 | |||