diff options
author | David Walter Seikel | 2016-03-29 02:16:55 +1000 |
---|---|---|
committer | David Walter Seikel | 2016-03-29 02:16:55 +1000 |
commit | cb3716ffb584fe0f593b6f1669a8efdba1305104 (patch) | |
tree | 5d1ebc4b6fc17b30f4b34e7e64a2d9514893459b /src/others/mimesh/libg3d-0.0.8/doc/api/xml/read.xml | |
parent | Add Prosody build script. (diff) | |
download | SledjHamr-cb3716ffb584fe0f593b6f1669a8efdba1305104.zip SledjHamr-cb3716ffb584fe0f593b6f1669a8efdba1305104.tar.gz SledjHamr-cb3716ffb584fe0f593b6f1669a8efdba1305104.tar.bz2 SledjHamr-cb3716ffb584fe0f593b6f1669a8efdba1305104.tar.xz |
Added my version of libg3d and friends.
Diffstat (limited to 'src/others/mimesh/libg3d-0.0.8/doc/api/xml/read.xml')
-rw-r--r-- | src/others/mimesh/libg3d-0.0.8/doc/api/xml/read.xml | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/src/others/mimesh/libg3d-0.0.8/doc/api/xml/read.xml b/src/others/mimesh/libg3d-0.0.8/doc/api/xml/read.xml new file mode 100644 index 0000000..08f1473 --- /dev/null +++ b/src/others/mimesh/libg3d-0.0.8/doc/api/xml/read.xml | |||
@@ -0,0 +1,218 @@ | |||
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-read"> | ||
5 | <refmeta> | ||
6 | <refentrytitle role="top_of_page" id="libg3d-read.top_of_page">read</refentrytitle> | ||
7 | <manvolnum>3</manvolnum> | ||
8 | <refmiscinfo>LIBG3D Library</refmiscinfo> | ||
9 | </refmeta> | ||
10 | |||
11 | <refnamediv> | ||
12 | <refname>read</refname> | ||
13 | <refpurpose>file reading abstraction (deprecated)</refpurpose> | ||
14 | <!--[<xref linkend="desc" endterm="desc.title"/>]--> | ||
15 | </refnamediv> | ||
16 | |||
17 | <refsynopsisdiv id="libg3d-read.synopsis" role="synopsis"> | ||
18 | <title role="synopsis.title">Synopsis</title> | ||
19 | |||
20 | <synopsis> | ||
21 | |||
22 | #include <g3d/read.h> | ||
23 | |||
24 | <link linkend="gint32">gint32</link> <link linkend="g3d-read-int8">g3d_read_int8</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
25 | <link linkend="gint32">gint32</link> <link linkend="g3d-read-int16-be">g3d_read_int16_be</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
26 | <link linkend="gint32">gint32</link> <link linkend="g3d-read-int16-le">g3d_read_int16_le</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
27 | <link linkend="gint32">gint32</link> <link linkend="g3d-read-int32-be">g3d_read_int32_be</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
28 | <link linkend="gint32">gint32</link> <link linkend="g3d-read-int32-le">g3d_read_int32_le</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
29 | <link linkend="G3DFloat">G3DFloat</link> <link linkend="g3d-read-float-be">g3d_read_float_be</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
30 | <link linkend="G3DFloat">G3DFloat</link> <link linkend="g3d-read-float-le">g3d_read_float_le</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
31 | <link linkend="G3DDouble">G3DDouble</link> <link linkend="g3d-read-double-be">g3d_read_double_be</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
32 | <link linkend="G3DDouble">G3DDouble</link> <link linkend="g3d-read-double-le">g3d_read_double_le</link> (<link linkend="FILE:CAPS">FILE</link> *f); | ||
33 | <link linkend="gint32">gint32</link> <link linkend="g3d-read-cstr">g3d_read_cstr</link> (<link linkend="FILE:CAPS">FILE</link> *f, | ||
34 | <link linkend="gchar">gchar</link> *buffer, | ||
35 | <link linkend="gint32">gint32</link> max_len); | ||
36 | </synopsis> | ||
37 | </refsynopsisdiv> | ||
38 | |||
39 | |||
40 | |||
41 | |||
42 | |||
43 | |||
44 | |||
45 | |||
46 | |||
47 | <refsect1 id="libg3d-read.description" role="desc"> | ||
48 | <title role="desc.title">Description</title> | ||
49 | <para> | ||
50 | The g3d_read_* family of functions is deprecated in favour of the <link linkend="G3DStream"><type>G3DStream</type></link> | ||
51 | interface.</para> | ||
52 | <para> | ||
53 | |||
54 | </para> | ||
55 | </refsect1> | ||
56 | |||
57 | <refsect1 id="libg3d-read.details" role="details"> | ||
58 | <title role="details.title">Details</title> | ||
59 | <refsect2 id="g3d-read-int8" role="function"> | ||
60 | <title>g3d_read_int8 ()</title> | ||
61 | <indexterm zone="g3d-read-int8"><primary>g3d_read_int8</primary></indexterm><programlisting><link linkend="gint32">gint32</link> g3d_read_int8 (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
62 | <para> | ||
63 | Read a 1 byte signed integer from file.</para> | ||
64 | <para> | ||
65 | |||
66 | </para><variablelist role="params"> | ||
67 | <varlistentry><term><parameter>f</parameter> :</term> | ||
68 | <listitem><simpara> the file to read from | ||
69 | </simpara></listitem></varlistentry> | ||
70 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
71 | </simpara></listitem></varlistentry> | ||
72 | </variablelist></refsect2> | ||
73 | <refsect2 id="g3d-read-int16-be" role="function"> | ||
74 | <title>g3d_read_int16_be ()</title> | ||
75 | <indexterm zone="g3d-read-int16-be"><primary>g3d_read_int16_be</primary></indexterm><programlisting><link linkend="gint32">gint32</link> g3d_read_int16_be (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
76 | <para> | ||
77 | Read a 2 byte big-endian signed integer from file.</para> | ||
78 | <para> | ||
79 | |||
80 | </para><variablelist role="params"> | ||
81 | <varlistentry><term><parameter>f</parameter> :</term> | ||
82 | <listitem><simpara> the file to read from | ||
83 | </simpara></listitem></varlistentry> | ||
84 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
85 | </simpara></listitem></varlistentry> | ||
86 | </variablelist></refsect2> | ||
87 | <refsect2 id="g3d-read-int16-le" role="function"> | ||
88 | <title>g3d_read_int16_le ()</title> | ||
89 | <indexterm zone="g3d-read-int16-le"><primary>g3d_read_int16_le</primary></indexterm><programlisting><link linkend="gint32">gint32</link> g3d_read_int16_le (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
90 | <para> | ||
91 | Read a 2 byte little-endian signed integer from file.</para> | ||
92 | <para> | ||
93 | |||
94 | </para><variablelist role="params"> | ||
95 | <varlistentry><term><parameter>f</parameter> :</term> | ||
96 | <listitem><simpara> the file to read from | ||
97 | </simpara></listitem></varlistentry> | ||
98 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
99 | </simpara></listitem></varlistentry> | ||
100 | </variablelist></refsect2> | ||
101 | <refsect2 id="g3d-read-int32-be" role="function"> | ||
102 | <title>g3d_read_int32_be ()</title> | ||
103 | <indexterm zone="g3d-read-int32-be"><primary>g3d_read_int32_be</primary></indexterm><programlisting><link linkend="gint32">gint32</link> g3d_read_int32_be (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
104 | <para> | ||
105 | Read a 4 byte big-endian signed integer from file.</para> | ||
106 | <para> | ||
107 | |||
108 | </para><variablelist role="params"> | ||
109 | <varlistentry><term><parameter>f</parameter> :</term> | ||
110 | <listitem><simpara> the file to read from | ||
111 | </simpara></listitem></varlistentry> | ||
112 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
113 | </simpara></listitem></varlistentry> | ||
114 | </variablelist></refsect2> | ||
115 | <refsect2 id="g3d-read-int32-le" role="function"> | ||
116 | <title>g3d_read_int32_le ()</title> | ||
117 | <indexterm zone="g3d-read-int32-le"><primary>g3d_read_int32_le</primary></indexterm><programlisting><link linkend="gint32">gint32</link> g3d_read_int32_le (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
118 | <para> | ||
119 | Read a 4 byte little-endian signed integer from file.</para> | ||
120 | <para> | ||
121 | |||
122 | </para><variablelist role="params"> | ||
123 | <varlistentry><term><parameter>f</parameter> :</term> | ||
124 | <listitem><simpara> the file to read from | ||
125 | </simpara></listitem></varlistentry> | ||
126 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
127 | </simpara></listitem></varlistentry> | ||
128 | </variablelist></refsect2> | ||
129 | <refsect2 id="g3d-read-float-be" role="function"> | ||
130 | <title>g3d_read_float_be ()</title> | ||
131 | <indexterm zone="g3d-read-float-be"><primary>g3d_read_float_be</primary></indexterm><programlisting><link linkend="G3DFloat">G3DFloat</link> g3d_read_float_be (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
132 | <para> | ||
133 | Read a 4 byte big-endian floating point number from file.</para> | ||
134 | <para> | ||
135 | |||
136 | </para><variablelist role="params"> | ||
137 | <varlistentry><term><parameter>f</parameter> :</term> | ||
138 | <listitem><simpara> the file to read from | ||
139 | </simpara></listitem></varlistentry> | ||
140 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
141 | </simpara></listitem></varlistentry> | ||
142 | </variablelist></refsect2> | ||
143 | <refsect2 id="g3d-read-float-le" role="function"> | ||
144 | <title>g3d_read_float_le ()</title> | ||
145 | <indexterm zone="g3d-read-float-le"><primary>g3d_read_float_le</primary></indexterm><programlisting><link linkend="G3DFloat">G3DFloat</link> g3d_read_float_le (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
146 | <para> | ||
147 | Read a 4 byte little-endian floating point number from file.</para> | ||
148 | <para> | ||
149 | |||
150 | </para><variablelist role="params"> | ||
151 | <varlistentry><term><parameter>f</parameter> :</term> | ||
152 | <listitem><simpara> the file to read from | ||
153 | </simpara></listitem></varlistentry> | ||
154 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
155 | </simpara></listitem></varlistentry> | ||
156 | </variablelist></refsect2> | ||
157 | <refsect2 id="g3d-read-double-be" role="function"> | ||
158 | <title>g3d_read_double_be ()</title> | ||
159 | <indexterm zone="g3d-read-double-be"><primary>g3d_read_double_be</primary></indexterm><programlisting><link linkend="G3DDouble">G3DDouble</link> g3d_read_double_be (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
160 | <para> | ||
161 | Read a 8 byte big-endian double-precision floating point number from file.</para> | ||
162 | <para> | ||
163 | |||
164 | </para><variablelist role="params"> | ||
165 | <varlistentry><term><parameter>f</parameter> :</term> | ||
166 | <listitem><simpara> the file to read from | ||
167 | </simpara></listitem></varlistentry> | ||
168 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
169 | </simpara></listitem></varlistentry> | ||
170 | </variablelist></refsect2> | ||
171 | <refsect2 id="g3d-read-double-le" role="function"> | ||
172 | <title>g3d_read_double_le ()</title> | ||
173 | <indexterm zone="g3d-read-double-le"><primary>g3d_read_double_le</primary></indexterm><programlisting><link linkend="G3DDouble">G3DDouble</link> g3d_read_double_le (<link linkend="FILE:CAPS">FILE</link> *f);</programlisting> | ||
174 | <para> | ||
175 | Read a 8 byte little-endian double-precision floating point number from | ||
176 | file.</para> | ||
177 | <para> | ||
178 | |||
179 | </para><variablelist role="params"> | ||
180 | <varlistentry><term><parameter>f</parameter> :</term> | ||
181 | <listitem><simpara> the file to read from | ||
182 | </simpara></listitem></varlistentry> | ||
183 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The read value, 0 in case of error | ||
184 | </simpara></listitem></varlistentry> | ||
185 | </variablelist></refsect2> | ||
186 | <refsect2 id="g3d-read-cstr" role="function"> | ||
187 | <title>g3d_read_cstr ()</title> | ||
188 | <indexterm zone="g3d-read-cstr"><primary>g3d_read_cstr</primary></indexterm><programlisting><link linkend="gint32">gint32</link> g3d_read_cstr (<link linkend="FILE:CAPS">FILE</link> *f, | ||
189 | <link linkend="gchar">gchar</link> *buffer, | ||
190 | <link linkend="gint32">gint32</link> max_len);</programlisting> | ||
191 | <para> | ||
192 | Read a zero-terminated string from file.</para> | ||
193 | <para> | ||
194 | |||
195 | </para><variablelist role="params"> | ||
196 | <varlistentry><term><parameter>f</parameter> :</term> | ||
197 | <listitem><simpara> the file to read from | ||
198 | </simpara></listitem></varlistentry> | ||
199 | <varlistentry><term><parameter>buffer</parameter> :</term> | ||
200 | <listitem><simpara> the buffer to store line in | ||
201 | </simpara></listitem></varlistentry> | ||
202 | <varlistentry><term><parameter>max_len</parameter> :</term> | ||
203 | <listitem><simpara> maximum length of string including termination character | ||
204 | </simpara></listitem></varlistentry> | ||
205 | <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> number of bytes read from file. | ||
206 | </simpara></listitem></varlistentry> | ||
207 | </variablelist></refsect2> | ||
208 | |||
209 | </refsect1> | ||
210 | |||
211 | |||
212 | |||
213 | <refsect1 id="libg3d-read.see-also"> | ||
214 | <title>See Also</title> | ||
215 | g3d_stream_open_file | ||
216 | </refsect1> | ||
217 | |||
218 | </refentry> | ||