/usr/share/gtk-doc/html/cogl/cogl-Primitives.html is in libcogl-doc 1.16.2-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Primitives</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Cogl Reference Manual">
<link rel="up" href="ch01.html" title="Cogl - a modern 3D graphics API">
<link rel="prev" href="cogl-Materials.html" title="Materials">
<link rel="next" href="cogl-Path-Primitives.html" title="Path Primitives">
<meta name="generator" content="GTK-Doc V1.19 (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="cogl-Materials.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">Cogl Reference Manual</th>
<td><a accesskey="n" href="cogl-Path-Primitives.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#cogl-Primitives.synopsis" class="shortcut">Top</a>
|
<a href="#cogl-Primitives.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="cogl-Primitives"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="cogl-Primitives.top_of_page"></a>Primitives</span></h2>
<p>Primitives — Functions that draw various primitive 3D shapes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="cogl-Primitives.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="cogl-Primitives.html#cogl-rectangle" title="cogl_rectangle ()">cogl_rectangle</a> (<em class="parameter"><code><span class="type">float</span> x_1</code></em>,
<em class="parameter"><code><span class="type">float</span> y_1</code></em>,
<em class="parameter"><code><span class="type">float</span> x_2</code></em>,
<em class="parameter"><code><span class="type">float</span> y_2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="cogl-Primitives.html#cogl-rectangles" title="cogl_rectangles ()">cogl_rectangles</a> (<em class="parameter"><code>const <span class="type">float</span> *verts</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> n_rects</code></em>);
<span class="returnvalue">void</span> <a class="link" href="cogl-Primitives.html#cogl-rectangle-with-texture-coords" title="cogl_rectangle_with_texture_coords ()">cogl_rectangle_with_texture_coords</a> (<em class="parameter"><code><span class="type">float</span> x1</code></em>,
<em class="parameter"><code><span class="type">float</span> y1</code></em>,
<em class="parameter"><code><span class="type">float</span> x2</code></em>,
<em class="parameter"><code><span class="type">float</span> y2</code></em>,
<em class="parameter"><code><span class="type">float</span> tx1</code></em>,
<em class="parameter"><code><span class="type">float</span> ty1</code></em>,
<em class="parameter"><code><span class="type">float</span> tx2</code></em>,
<em class="parameter"><code><span class="type">float</span> ty2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="cogl-Primitives.html#cogl-rectangles-with-texture-coords" title="cogl_rectangles_with_texture_coords ()">cogl_rectangles_with_texture_coords</a> (<em class="parameter"><code>const <span class="type">float</span> *verts</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> n_rects</code></em>);
<span class="returnvalue">void</span> <a class="link" href="cogl-Primitives.html#cogl-rectangle-with-multitexture-coords" title="cogl_rectangle_with_multitexture_coords ()">cogl_rectangle_with_multitexture_coords</a>
(<em class="parameter"><code><span class="type">float</span> x1</code></em>,
<em class="parameter"><code><span class="type">float</span> y1</code></em>,
<em class="parameter"><code><span class="type">float</span> x2</code></em>,
<em class="parameter"><code><span class="type">float</span> y2</code></em>,
<em class="parameter"><code>const <span class="type">float</span> *tex_coords</code></em>,
<em class="parameter"><code><span class="type">int</span> tex_coords_len</code></em>);
<span class="returnvalue">void</span> <a class="link" href="cogl-Primitives.html#cogl-polygon" title="cogl_polygon ()">cogl_polygon</a> (<em class="parameter"><code>const <a class="link" href="cogl-Textures.html#CoglTextureVertex" title="struct CoglTextureVertex"><span class="type">CoglTextureVertex</span></a> *vertices</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> n_vertices</code></em>,
<em class="parameter"><code><span class="type">CoglBool</span> use_color</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="cogl-Primitives.description"></a><h2>Description</h2>
<p>
The primitives API provides utilities for drawing some
common 3D shapes in a more convenient way than the CoglVertexBuffer
API provides.
</p>
</div>
<div class="refsect1">
<a name="cogl-Primitives.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="cogl-rectangle"></a><h3>cogl_rectangle ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> cogl_rectangle (<em class="parameter"><code><span class="type">float</span> x_1</code></em>,
<em class="parameter"><code><span class="type">float</span> y_1</code></em>,
<em class="parameter"><code><span class="type">float</span> x_2</code></em>,
<em class="parameter"><code><span class="type">float</span> y_2</code></em>);</pre>
<p>
Fills a rectangle at the given coordinates with the current source material
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x_1</code></em> :</span></p></td>
<td>X coordinate of the top-left corner</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y_1</code></em> :</span></p></td>
<td>Y coordinate of the top-left corner</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x_2</code></em> :</span></p></td>
<td>X coordinate of the bottom-right corner</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y_2</code></em> :</span></p></td>
<td>Y coordinate of the bottom-right corner</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-rectangles"></a><h3>cogl_rectangles ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> cogl_rectangles (<em class="parameter"><code>const <span class="type">float</span> *verts</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> n_rects</code></em>);</pre>
<p>
Draws a series of rectangles in the same way that
<a class="link" href="cogl-Primitives.html#cogl-rectangle" title="cogl_rectangle ()"><code class="function">cogl_rectangle()</code></a> does. In some situations it can give a
significant performance boost to use this function rather than
calling <a class="link" href="cogl-Primitives.html#cogl-rectangle" title="cogl_rectangle ()"><code class="function">cogl_rectangle()</code></a> separately for each rectangle.
</p>
<p>
<em class="parameter"><code>verts</code></em> should point to an array of <span class="type">float</span>s with
<em class="parameter"><code>n_rects</code></em> * 4 elements. Each group of 4 values corresponds to the
parameters x1, y1, x2, and y2, and have the same
meaning as in <a class="link" href="cogl-Primitives.html#cogl-rectangle" title="cogl_rectangle ()"><code class="function">cogl_rectangle()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>verts</code></em> :</span></p></td>
<td>an array of vertices. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_rects</code></em> :</span></p></td>
<td>number of rectangles to draw</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-rectangle-with-texture-coords"></a><h3>cogl_rectangle_with_texture_coords ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> cogl_rectangle_with_texture_coords (<em class="parameter"><code><span class="type">float</span> x1</code></em>,
<em class="parameter"><code><span class="type">float</span> y1</code></em>,
<em class="parameter"><code><span class="type">float</span> x2</code></em>,
<em class="parameter"><code><span class="type">float</span> y2</code></em>,
<em class="parameter"><code><span class="type">float</span> tx1</code></em>,
<em class="parameter"><code><span class="type">float</span> ty1</code></em>,
<em class="parameter"><code><span class="type">float</span> tx2</code></em>,
<em class="parameter"><code><span class="type">float</span> ty2</code></em>);</pre>
<p>
Draw a rectangle using the current material and supply texture coordinates
to be used for the first texture layer of the material. To draw the entire
texture pass in <em class="parameter"><code>tx1</code></em>=0.0 <em class="parameter"><code>ty1</code></em>=0.0 <em class="parameter"><code>tx2</code></em>=1.0 <em class="parameter"><code>ty2</code></em>=1.0.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
<td>x coordinate upper left on screen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
<td>y coordinate upper left on screen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
<td>x coordinate lower right on screen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
<td>y coordinate lower right on screen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tx1</code></em> :</span></p></td>
<td>x part of texture coordinate to use for upper left pixel</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ty1</code></em> :</span></p></td>
<td>y part of texture coordinate to use for upper left pixel</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tx2</code></em> :</span></p></td>
<td>x part of texture coordinate to use for lower right pixel</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ty2</code></em> :</span></p></td>
<td>y part of texture coordinate to use for left pixel</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-rectangles-with-texture-coords"></a><h3>cogl_rectangles_with_texture_coords ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> cogl_rectangles_with_texture_coords (<em class="parameter"><code>const <span class="type">float</span> *verts</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> n_rects</code></em>);</pre>
<p>
Draws a series of rectangles in the same way that
<a class="link" href="cogl-Primitives.html#cogl-rectangle-with-texture-coords" title="cogl_rectangle_with_texture_coords ()"><code class="function">cogl_rectangle_with_texture_coords()</code></a> does. In some situations it can give a
significant performance boost to use this function rather than
calling <a class="link" href="cogl-Primitives.html#cogl-rectangle-with-texture-coords" title="cogl_rectangle_with_texture_coords ()"><code class="function">cogl_rectangle_with_texture_coords()</code></a> separately for each rectangle.
</p>
<p>
<em class="parameter"><code>verts</code></em> should point to an array of <span class="type">float</span>s with
<em class="parameter"><code>n_rects</code></em> * 8 elements. Each group of 8 values corresponds to the
parameters x1, y1, x2, y2, tx1, ty1, tx2 and ty2 and have the same
meaning as in <a class="link" href="cogl-Primitives.html#cogl-rectangle-with-texture-coords" title="cogl_rectangle_with_texture_coords ()"><code class="function">cogl_rectangle_with_texture_coords()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>verts</code></em> :</span></p></td>
<td>an array of vertices. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_rects</code></em> :</span></p></td>
<td>number of rectangles to draw</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8.6</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-rectangle-with-multitexture-coords"></a><h3>cogl_rectangle_with_multitexture_coords ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> cogl_rectangle_with_multitexture_coords
(<em class="parameter"><code><span class="type">float</span> x1</code></em>,
<em class="parameter"><code><span class="type">float</span> y1</code></em>,
<em class="parameter"><code><span class="type">float</span> x2</code></em>,
<em class="parameter"><code><span class="type">float</span> y2</code></em>,
<em class="parameter"><code>const <span class="type">float</span> *tex_coords</code></em>,
<em class="parameter"><code><span class="type">int</span> tex_coords_len</code></em>);</pre>
<p>
This function draws a rectangle using the current source material to
texture or fill with. As a material may contain multiple texture layers
this interface lets you supply texture coordinates for each layer of the
material.
</p>
<p>
The first pair of coordinates are for the first layer (with the smallest
layer index) and if you supply less texture coordinates than there are
layers in the current source material then default texture coordinates
(0.0, 0.0, 1.0, 1.0) are generated.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
<td>x coordinate upper left on screen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
<td>y coordinate upper left on screen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
<td>x coordinate lower right on screen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
<td>y coordinate lower right on screen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tex_coords</code></em> :</span></p></td>
<td>An array containing groups of
4 float values: [tx1, ty1, tx2, ty2] that are interpreted as two texture
coordinates; one for the upper left texel, and one for the lower right
texel. Each value should be between 0.0 and 1.0, where the coordinate
(0.0, 0.0) represents the top left of the texture, and (1.0, 1.0) the
bottom right. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tex_coords_len</code></em> :</span></p></td>
<td>The length of the tex_coords array. (e.g. for one layer
and one group of texture coordinates, this would be 4)</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-polygon"></a><h3>cogl_polygon ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> cogl_polygon (<em class="parameter"><code>const <a class="link" href="cogl-Textures.html#CoglTextureVertex" title="struct CoglTextureVertex"><span class="type">CoglTextureVertex</span></a> *vertices</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> n_vertices</code></em>,
<em class="parameter"><code><span class="type">CoglBool</span> use_color</code></em>);</pre>
<p>
Draws a convex polygon using the current source material to fill / texture
with according to the texture coordinates passed.
</p>
<p>
If <em class="parameter"><code>use_color</code></em> is <code class="literal">TRUE</code> then the color will be changed for each vertex using
the value specified in the color member of <a class="link" href="cogl-Textures.html#CoglTextureVertex" title="struct CoglTextureVertex"><span class="type">CoglTextureVertex</span></a>. This can be
used for example to make the texture fade out by setting the alpha value of
the color.
</p>
<p>
All of the texture coordinates must be in the range [0,1] and repeating the
texture is not supported.
</p>
<p>
Because of the way this function is implemented it will currently
only work if either the texture is not sliced or the backend is not
OpenGL ES and the minifying and magnifying functions are both set
to COGL_MATERIAL_FILTER_NEAREST.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vertices</code></em> :</span></p></td>
<td>An array of <a class="link" href="cogl-Textures.html#CoglTextureVertex" title="struct CoglTextureVertex"><span class="type">CoglTextureVertex</span></a> structs</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_vertices</code></em> :</span></p></td>
<td>The length of the vertices array</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>use_color</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the color member of <a class="link" href="cogl-Textures.html#CoglTextureVertex" title="struct CoglTextureVertex"><span class="type">CoglTextureVertex</span></a> should be used</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|