/usr/share/gtk-doc/html/libg3d/libg3d-face.html is in libg3d-doc 0.0.8-17ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>face</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libg3d Reference Manual">
<link rel="up" href="ch01.html" title="Application interface">
<link rel="prev" href="libg3d-object.html" title="object">
<link rel="next" href="libg3d-material.html" title="material">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libg3d-object.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libg3d Reference Manual</th>
<td><a accesskey="n" href="libg3d-material.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libg3d-face.synopsis" class="shortcut">Top</a>
|
<a href="#libg3d-face.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libg3d-face"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libg3d-face.top_of_page"></a>face</span></h2>
<p>face — Face manipulation</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libg3d-face.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <g3d/face.h>
#define <a class="link" href="libg3d-face.html#G3D-FLAG-MAT-TWOSIDE:CAPS" title="G3D_FLAG_MAT_TWOSIDE">G3D_FLAG_MAT_TWOSIDE</a>
#define <a class="link" href="libg3d-face.html#G3D-FLAG-FAC-NORMALS:CAPS" title="G3D_FLAG_FAC_NORMALS">G3D_FLAG_FAC_NORMALS</a>
#define <a class="link" href="libg3d-face.html#G3D-FLAG-FAC-TEXMAP:CAPS" title="G3D_FLAG_FAC_TEXMAP">G3D_FLAG_FAC_TEXMAP</a>
<a class="link" href="libg3d-face.html#G3DFace" title="G3DFace">G3DFace</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-face.html#g3d-face-get-normal" title="g3d_face_get_normal ()">g3d_face_get_normal</a> (<em class="parameter"><code><a class="link" href="libg3d-face.html#G3DFace" title="G3DFace"><span class="type">G3DFace</span></a> *face</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *ny</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nz</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libg3d-face.html#g3d-face-free" title="g3d_face_free ()">g3d_face_free</a> (<em class="parameter"><code><a class="link" href="libg3d-face.html#G3DFace" title="G3DFace"><span class="type">G3DFace</span></a> *face</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libg3d-face.description"></a><h2>Description</h2>
<p>
A face is plane bordered by at least 3 vertices.
</p>
</div>
<div class="refsect1">
<a name="libg3d-face.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="G3D-FLAG-MAT-TWOSIDE:CAPS"></a><h3>G3D_FLAG_MAT_TWOSIDE</h3>
<pre class="programlisting">#define G3D_FLAG_MAT_TWOSIDE (1L << 0)
</pre>
<p>
Faces using this material should be rendered two-sided as the direction
is unknown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="G3D-FLAG-FAC-NORMALS:CAPS"></a><h3>G3D_FLAG_FAC_NORMALS</h3>
<pre class="programlisting">#define G3D_FLAG_FAC_NORMALS (1L << 0)
</pre>
<p>
The face has custom normals.
</p>
</div>
<hr>
<div class="refsect2">
<a name="G3D-FLAG-FAC-TEXMAP:CAPS"></a><h3>G3D_FLAG_FAC_TEXMAP</h3>
<pre class="programlisting">#define G3D_FLAG_FAC_TEXMAP (1L << 1)
</pre>
<p>
The face has a texture map and texture coordinates.
</p>
</div>
<hr>
<div class="refsect2">
<a name="G3DFace"></a><h3>G3DFace</h3>
<pre class="programlisting">typedef struct {
guint32 vertex_count;
guint32 *vertex_indices;
G3DMaterial *material;
guint32 flags;
G3DVector *normals;
G3DImage *tex_image;
guint32 tex_vertex_count;
G3DVector *tex_vertex_data;
} G3DFace;
</pre>
<p>
An object representing a surface.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DFace.vertex-count"></a>vertex_count</code></em>;</span></p></td>
<td>number of vertices</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> *<em class="structfield"><code><a name="G3DFace.vertex-indices"></a>vertex_indices</code></em>;</span></p></td>
<td>indices of vertices in <a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-material.html#G3DMaterial" title="G3DMaterial"><span class="type">G3DMaterial</span></a> *<em class="structfield"><code><a name="G3DFace.material"></a>material</code></em>;</span></p></td>
<td>material to use for surface</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DFace.flags"></a>flags</code></em>;</span></p></td>
<td>flags</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector"><span class="type">G3DVector</span></a> *<em class="structfield"><code><a name="G3DFace.normals"></a>normals</code></em>;</span></p></td>
<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
vertex)</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *<em class="structfield"><code><a name="G3DFace.tex-image"></a>tex_image</code></em>;</span></p></td>
<td>optional texture image</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DFace.tex-vertex-count"></a>tex_vertex_count</code></em>;</span></p></td>
<td>number of texture vertices, should be 0 or match
vertex_count</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector"><span class="type">G3DVector</span></a> *<em class="structfield"><code><a name="G3DFace.tex-vertex-data"></a>tex_vertex_data</code></em>;</span></p></td>
<td>array of texture vertices</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-face-get-normal"></a><h3>g3d_face_get_normal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_face_get_normal (<em class="parameter"><code><a class="link" href="libg3d-face.html#G3DFace" title="G3DFace"><span class="type">G3DFace</span></a> *face</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *ny</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nz</code></em>);</pre>
<p>
calculates the normal of a face.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>face</code></em> :</span></p></td>
<td>face to calculate normal of</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>object containing vertices of face</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nx</code></em> :</span></p></td>
<td>x component of resulting normal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ny</code></em> :</span></p></td>
<td>y component of resulting normal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nz</code></em> :</span></p></td>
<td>z component of resulting normal</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-face-free"></a><h3>g3d_face_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g3d_face_free (<em class="parameter"><code><a class="link" href="libg3d-face.html#G3DFace" title="G3DFace"><span class="type">G3DFace</span></a> *face</code></em>);</pre>
<p>
Frees all memory allocated for this face.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>face</code></em> :</span></p></td>
<td>the face to free</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|