/usr/share/gtk-doc/html/libg3d/libg3d-texture.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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>texture</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-material.html" title="material">
<link rel="next" href="ch02.html" title="Plugin interface">
<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-material.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="ch02.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-texture.synopsis" class="shortcut">Top</a>
|
<a href="#libg3d-texture.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libg3d-texture"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libg3d-texture.top_of_page"></a>texture</span></h2>
<p>texture — Texture loading and manipulation</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libg3d-texture.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <g3d/texture.h>
#define <a class="link" href="libg3d-texture.html#G3D-FLAG-IMG-GREYSCALE:CAPS" title="G3D_FLAG_IMG_GREYSCALE">G3D_FLAG_IMG_GREYSCALE</a>
enum <a class="link" href="libg3d-texture.html#G3DTexEnv" title="enum G3DTexEnv">G3DTexEnv</a>;
<a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage">G3DImage</a>;
<a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="returnvalue">G3DImage</span></a> * <a class="link" href="libg3d-texture.html#g3d-texture-load-cached" title="g3d_texture_load_cached ()">g3d_texture_load_cached</a> (<em class="parameter"><code><a class="link" href="libg3d-context.html#G3DContext" title="G3DContext"><span class="type">G3DContext</span></a> *context</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
<a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="returnvalue">G3DImage</span></a> * <a class="link" href="libg3d-texture.html#g3d-texture-load-from-stream" title="g3d_texture_load_from_stream ()">g3d_texture_load_from_stream</a> (<em class="parameter"><code><a class="link" href="libg3d-context.html#G3DContext" title="G3DContext"><span class="type">G3DContext</span></a> *context</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-stream.html#G3DStream" title="G3DStream"><span class="type">G3DStream</span></a> *stream</code></em>);
<a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="returnvalue">G3DImage</span></a> * <a class="link" href="libg3d-texture.html#g3d-texture-load" title="g3d_texture_load ()">g3d_texture_load</a> (<em class="parameter"><code><a class="link" href="libg3d-context.html#G3DContext" title="G3DContext"><span class="type">G3DContext</span></a> *context</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libg3d-texture.html#g3d-texture-free" title="g3d_texture_free ()">g3d_texture_free</a> (<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *texture</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-texture.html#g3d-texture-prepare" title="g3d_texture_prepare ()">g3d_texture_prepare</a> (<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *texture</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-texture.html#g3d-texture-flip-y" title="g3d_texture_flip_y ()">g3d_texture_flip_y</a> (<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *texture</code></em>);
<a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="returnvalue">G3DImage</span></a> * <a class="link" href="libg3d-texture.html#g3d-texture-merge-alpha" title="g3d_texture_merge_alpha ()">g3d_texture_merge_alpha</a> (<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *image</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *aimage</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libg3d-texture.description"></a><h2>Description</h2>
<p>
A texture is an image used in materials. Here are some helper functions,
mostly for cached loading of a <a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a>.
</p>
</div>
<div class="refsect1">
<a name="libg3d-texture.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="G3D-FLAG-IMG-GREYSCALE:CAPS"></a><h3>G3D_FLAG_IMG_GREYSCALE</h3>
<pre class="programlisting">#define G3D_FLAG_IMG_GREYSCALE (1L << 1)
</pre>
<p>
The image just uses the red channel for grey value
</p>
</div>
<hr>
<div class="refsect2">
<a name="G3DTexEnv"></a><h3>enum G3DTexEnv</h3>
<pre class="programlisting">typedef enum {
G3D_TEXENV_UNSPECIFIED = 0,
G3D_TEXENV_BLEND,
G3D_TEXENV_DECAL,
G3D_TEXENV_MODULATE,
G3D_TEXENV_REPLACE
} G3DTexEnv;
</pre>
<p>
Specify how the texture should interact with other material properties.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="G3D-TEXENV-UNSPECIFIED:CAPS"></a><span class="term"><code class="literal">G3D_TEXENV_UNSPECIFIED</code></span></p></td>
<td>unspecified, application decides
</td>
</tr>
<tr>
<td><p><a name="G3D-TEXENV-BLEND:CAPS"></a><span class="term"><code class="literal">G3D_TEXENV_BLEND</code></span></p></td>
<td>use blending
</td>
</tr>
<tr>
<td><p><a name="G3D-TEXENV-DECAL:CAPS"></a><span class="term"><code class="literal">G3D_TEXENV_DECAL</code></span></p></td>
<td>use as decal
</td>
</tr>
<tr>
<td><p><a name="G3D-TEXENV-MODULATE:CAPS"></a><span class="term"><code class="literal">G3D_TEXENV_MODULATE</code></span></p></td>
<td>use modulate
</td>
</tr>
<tr>
<td><p><a name="G3D-TEXENV-REPLACE:CAPS"></a><span class="term"><code class="literal">G3D_TEXENV_REPLACE</code></span></p></td>
<td>replace color
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="G3DImage"></a><h3>G3DImage</h3>
<pre class="programlisting">typedef struct {
gchar *name;
guint32 width;
guint32 height;
guint8 depth;
guint32 flags;
guint8 *pixeldata;
guint32 tex_id;
G3DTexEnv tex_env;
G3DFloat tex_scale_u;
G3DFloat tex_scale_v;
} G3DImage;
</pre>
<p>
Object containing a two-dimensional pixel image.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="G3DImage.name"></a>name</code></em>;</span></p></td>
<td>name of image</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DImage.width"></a>width</code></em>;</span></p></td>
<td>width of image in pixels</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DImage.height"></a>height</code></em>;</span></p></td>
<td>height of image in pixels</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint8</span> <em class="structfield"><code><a name="G3DImage.depth"></a>depth</code></em>;</span></p></td>
<td>depth of image in bits</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DImage.flags"></a>flags</code></em>;</span></p></td>
<td>flags</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint8</span> *<em class="structfield"><code><a name="G3DImage.pixeldata"></a>pixeldata</code></em>;</span></p></td>
<td>the binary image data</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DImage.tex-id"></a>tex_id</code></em>;</span></p></td>
<td>the OpenGL texture id, should be unique model-wide</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-texture.html#G3DTexEnv" title="enum G3DTexEnv"><span class="type">G3DTexEnv</span></a> <em class="structfield"><code><a name="G3DImage.tex-env"></a>tex_env</code></em>;</span></p></td>
<td>texture environment flags</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> <em class="structfield"><code><a name="G3DImage.tex-scale-u"></a>tex_scale_u</code></em>;</span></p></td>
<td>factor scaling texture width, should be 1.0 for most cases</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> <em class="structfield"><code><a name="G3DImage.tex-scale-v"></a>tex_scale_v</code></em>;</span></p></td>
<td>factor scaling texture height, should be 1.0 for most cases</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-texture-load-cached"></a><h3>g3d_texture_load_cached ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="returnvalue">G3DImage</span></a> * g3d_texture_load_cached (<em class="parameter"><code><a class="link" href="libg3d-context.html#G3DContext" title="G3DContext"><span class="type">G3DContext</span></a> *context</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>
Loads a texture image from file and attaches it to a hash table in the
model. On a second try to load this texture it is returned from cache.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a valid context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>a valid model</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>the file name of the texture to load</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the texture image</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-texture-load-from-stream"></a><h3>g3d_texture_load_from_stream ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="returnvalue">G3DImage</span></a> * g3d_texture_load_from_stream (<em class="parameter"><code><a class="link" href="libg3d-context.html#G3DContext" title="G3DContext"><span class="type">G3DContext</span></a> *context</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-stream.html#G3DStream" title="G3DStream"><span class="type">G3DStream</span></a> *stream</code></em>);</pre>
<p>
Load a texture image from a stream. The file type is determined by the
extension of the stream URI, so it should be valid. If <em class="parameter"><code>model</code></em> is not NULL
the texture image is cached (or retrieved from cache if available).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a valid context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>a valid model or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>an open stream</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the texture image or NULL in case of an error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-texture-load"></a><h3>g3d_texture_load ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="returnvalue">G3DImage</span></a> * g3d_texture_load (<em class="parameter"><code><a class="link" href="libg3d-context.html#G3DContext" title="G3DContext"><span class="type">G3DContext</span></a> *context</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>
Load a texture from a file. The type of file is determined by the file
extension.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a valid context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>the file name of the texture</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the texture image or NULL in case of an error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-texture-free"></a><h3>g3d_texture_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g3d_texture_free (<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *texture</code></em>);</pre>
<p>
Frees all memory used by this texture image.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
<td>a texture image</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-texture-prepare"></a><h3>g3d_texture_prepare ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_texture_prepare (<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *texture</code></em>);</pre>
<p>
Resizes the image to dimensions which are a power of 2 to be
usable as an OpenGL texture.
(FIXME: unimplemented)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
<td>a texture image</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-texture-flip-y"></a><h3>g3d_texture_flip_y ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_texture_flip_y (<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *texture</code></em>);</pre>
<p>
Mirror the image along the x axis - all y coordinates are inverted.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
<td>a texture image</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-texture-merge-alpha"></a><h3>g3d_texture_merge_alpha ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="returnvalue">G3DImage</span></a> * g3d_texture_merge_alpha (<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *image</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-texture.html#G3DImage" title="G3DImage"><span class="type">G3DImage</span></a> *aimage</code></em>);</pre>
<p>
Merges alpha information from <em class="parameter"><code>aimage</code></em> into output image. If <em class="parameter"><code>image</code></em> is NULL a
new image is created, else <em class="parameter"><code>image</code></em> is returned with alpha from <em class="parameter"><code>aimage</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
<td>a texture image or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>aimage</code></em> :</span></p></td>
<td>an image with alpha information</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a texture image or NULL in case of an error.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|