aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-face.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-face.html')
-rw-r--r--src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-face.html255
1 files changed, 255 insertions, 0 deletions
diff --git a/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-face.html b/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-face.html
new file mode 100644
index 0000000..5ae49f3
--- /dev/null
+++ b/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-face.html
@@ -0,0 +1,255 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>face</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7<link rel="start" href="index.html" title="libg3d Reference Manual">
8<link rel="up" href="ch01.html" title="Application interface">
9<link rel="prev" href="libg3d-object.html" title="object">
10<link rel="next" href="libg3d-material.html" title="material">
11<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12<link rel="stylesheet" href="style.css" type="text/css">
13<link rel="chapter" href="ch01.html" title="Application interface">
14<link rel="chapter" href="ch02.html" title="Plugin interface">
15</head>
16<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
17<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
18<tr valign="middle">
19<td><a accesskey="p" href="libg3d-object.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
20<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
21<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
22<th width="100%" align="center">libg3d Reference Manual</th>
23<td><a accesskey="n" href="libg3d-material.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24</tr>
25<tr><td colspan="5" class="shortcuts"><nobr><a href="#libg3d-face.synopsis" class="shortcut">Top</a>
26  | 
27 <a href="#libg3d-face.description" class="shortcut">Description</a></nobr></td></tr>
28</table>
29<div class="refentry" lang="en">
30<a name="libg3d-face"></a><div class="titlepage"></div>
31<div class="refnamediv"><table width="100%"><tr>
32<td valign="top">
33<h2><span class="refentrytitle"><a name="libg3d-face.top_of_page"></a>face</span></h2>
34<p>face — Face manipulation</p>
35</td>
36<td valign="top" align="right"></td>
37</tr></table></div>
38<div class="refsynopsisdiv">
39<a name="libg3d-face.synopsis"></a><h2>Synopsis</h2>
40<pre class="synopsis">
41
42#include &lt;g3d/face.h&gt;
43
44#define <a class="link" href="libg3d-face.html#G3D-FLAG-MAT-TWOSIDE:CAPS" title="G3D_FLAG_MAT_TWOSIDE">G3D_FLAG_MAT_TWOSIDE</a>
45#define <a class="link" href="libg3d-face.html#G3D-FLAG-FAC-NORMALS:CAPS" title="G3D_FLAG_FAC_NORMALS">G3D_FLAG_FAC_NORMALS</a>
46#define <a class="link" href="libg3d-face.html#G3D-FLAG-FAC-TEXMAP:CAPS" title="G3D_FLAG_FAC_TEXMAP">G3D_FLAG_FAC_TEXMAP</a>
47 <a class="link" href="libg3d-face.html#G3DFace" title="G3DFace">G3DFace</a>;
48<a
49href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
50>gboolean</a> <a class="link" href="libg3d-face.html#g3d-face-get-normal" title="g3d_face_get_normal ()">g3d_face_get_normal</a> (<a class="link" href="libg3d-face.html#G3DFace" title="G3DFace">G3DFace</a> *face,
51 <a class="link" href="libg3d-object.html#G3DObject" title="G3DObject">G3DObject</a> *object,
52 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nx,
53 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *ny,
54 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nz);
55void <a class="link" href="libg3d-face.html#g3d-face-free" title="g3d_face_free ()">g3d_face_free</a> (<a class="link" href="libg3d-face.html#G3DFace" title="G3DFace">G3DFace</a> *face);
56</pre>
57</div>
58<div class="refsect1" lang="en">
59<a name="libg3d-face.description"></a><h2>Description</h2>
60<p>
61A face is plane bordered by at least 3 vertices.</p>
62<p>
63
64</p>
65</div>
66<div class="refsect1" lang="en">
67<a name="libg3d-face.details"></a><h2>Details</h2>
68<div class="refsect2" lang="en">
69<a name="G3D-FLAG-MAT-TWOSIDE:CAPS"></a><h3>G3D_FLAG_MAT_TWOSIDE</h3>
70<pre class="programlisting">#define G3D_FLAG_MAT_TWOSIDE (1L &lt;&lt; 0)
71</pre>
72<p>
73Faces using this material should be rendered two-sided as the direction
74is unknown.</p>
75<p>
76
77</p>
78</div>
79<hr>
80<div class="refsect2" lang="en">
81<a name="G3D-FLAG-FAC-NORMALS:CAPS"></a><h3>G3D_FLAG_FAC_NORMALS</h3>
82<pre class="programlisting">#define G3D_FLAG_FAC_NORMALS (1L &lt;&lt; 0)
83</pre>
84<p>
85The face has custom normals.</p>
86<p>
87
88</p>
89</div>
90<hr>
91<div class="refsect2" lang="en">
92<a name="G3D-FLAG-FAC-TEXMAP:CAPS"></a><h3>G3D_FLAG_FAC_TEXMAP</h3>
93<pre class="programlisting">#define G3D_FLAG_FAC_TEXMAP (1L &lt;&lt; 1)
94</pre>
95<p>
96The face has a texture map and texture coordinates.</p>
97<p>
98
99</p>
100</div>
101<hr>
102<div class="refsect2" lang="en">
103<a name="G3DFace"></a><h3>G3DFace</h3>
104<pre class="programlisting">typedef struct {
105 guint32 vertex_count;
106 guint32 *vertex_indices;
107
108 G3DMaterial *material;
109
110 guint32 flags;
111
112 G3DVector *normals;
113
114 G3DImage *tex_image;
115 guint32 tex_vertex_count;
116 G3DVector *tex_vertex_data;
117} G3DFace;
118</pre>
119<p>
120An object representing a surface.</p>
121<p>
122
123</p>
124<div class="variablelist"><table border="0">
125<col align="left" valign="top">
126<tbody>
127<tr>
128<td><p><span class="term"><a
129href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
130>guint32</a> <em class="structfield"><code>vertex_count</code></em>;</span></p></td>
131<td> number of vertices
132</td>
133</tr>
134<tr>
135<td><p><span class="term"><a
136href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
137>guint32</a> *<em class="structfield"><code>vertex_indices</code></em>;</span></p></td>
138<td> indices of vertices in <a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a>
139</td>
140</tr>
141<tr>
142<td><p><span class="term"><a class="link" href="libg3d-material.html#G3DMaterial" title="G3DMaterial">G3DMaterial</a> *<em class="structfield"><code>material</code></em>;</span></p></td>
143<td> material to use for surface
144</td>
145</tr>
146<tr>
147<td><p><span class="term"><a
148href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
149>guint32</a> <em class="structfield"><code>flags</code></em>;</span></p></td>
150<td> flags
151</td>
152</tr>
153<tr>
154<td><p><span class="term"><a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector">G3DVector</a> *<em class="structfield"><code>normals</code></em>;</span></p></td>
155<td> optional normal array (one vector - 3 <a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector"><span class="type">G3DVector</span></a> values - for each
156 vertex)
157</td>
158</tr>
159<tr>
160<td><p><span class="term"><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage">G3DImage</a> *<em class="structfield"><code>tex_image</code></em>;</span></p></td>
161<td> optional texture image
162</td>
163</tr>
164<tr>
165<td><p><span class="term"><a
166href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
167>guint32</a> <em class="structfield"><code>tex_vertex_count</code></em>;</span></p></td>
168<td> number of texture vertices, should be 0 or match
169 vertex_count
170</td>
171</tr>
172<tr>
173<td><p><span class="term"><a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector">G3DVector</a> *<em class="structfield"><code>tex_vertex_data</code></em>;</span></p></td>
174<td> array of texture vertices
175</td>
176</tr>
177</tbody>
178</table></div>
179</div>
180<hr>
181<div class="refsect2" lang="en">
182<a name="g3d-face-get-normal"></a><h3>g3d_face_get_normal ()</h3>
183<pre class="programlisting"><a
184href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
185>gboolean</a> g3d_face_get_normal (<a class="link" href="libg3d-face.html#G3DFace" title="G3DFace">G3DFace</a> *face,
186 <a class="link" href="libg3d-object.html#G3DObject" title="G3DObject">G3DObject</a> *object,
187 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nx,
188 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *ny,
189 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nz);</pre>
190<p>
191calculates the normal of a face.</p>
192<p>
193
194</p>
195<div class="variablelist"><table border="0">
196<col align="left" valign="top">
197<tbody>
198<tr>
199<td><p><span class="term"><em class="parameter"><code>face</code></em> :</span></p></td>
200<td> face to calculate normal of
201</td>
202</tr>
203<tr>
204<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
205<td> object containing vertices of face
206</td>
207</tr>
208<tr>
209<td><p><span class="term"><em class="parameter"><code>nx</code></em> :</span></p></td>
210<td> x component of resulting normal
211</td>
212</tr>
213<tr>
214<td><p><span class="term"><em class="parameter"><code>ny</code></em> :</span></p></td>
215<td> y component of resulting normal
216</td>
217</tr>
218<tr>
219<td><p><span class="term"><em class="parameter"><code>nz</code></em> :</span></p></td>
220<td> z component of resulting normal
221</td>
222</tr>
223<tr>
224<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
225<td> TRUE on success, FALSE else
226</td>
227</tr>
228</tbody>
229</table></div>
230</div>
231<hr>
232<div class="refsect2" lang="en">
233<a name="g3d-face-free"></a><h3>g3d_face_free ()</h3>
234<pre class="programlisting">void g3d_face_free (<a class="link" href="libg3d-face.html#G3DFace" title="G3DFace">G3DFace</a> *face);</pre>
235<p>
236Frees all memory allocated for this face.</p>
237<p>
238
239</p>
240<div class="variablelist"><table border="0">
241<col align="left" valign="top">
242<tbody><tr>
243<td><p><span class="term"><em class="parameter"><code>face</code></em> :</span></p></td>
244<td> the face to free
245</td>
246</tr></tbody>
247</table></div>
248</div>
249</div>
250</div>
251<div class="footer">
252<hr>
253 Generated by GTK-Doc V1.10</div>
254</body>
255</html>
generated by cgit v1.1 at 2024-05-22 01:05:10 +0000