libcogl-doc 1.22.2-3 / usr / share / gtk-doc / html / cogl / cogl-Primitives.html

This file is indexed.

/usr/share/gtk-doc/html/cogl/cogl-Primitives.html is in libcogl-doc 1.22.2-3.

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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
<!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: Cogl Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#cogl-Primitives.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="cogl-Materials.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="cogl-Path-Primitives.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="cogl-Primitives.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-Primitives.html#cogl-rectangle" title="cogl_rectangle ()">cogl_rectangle</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-Primitives.html#cogl-rectangles" title="cogl_rectangles ()">cogl_rectangles</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-Primitives.html#cogl-rectangle-with-texture-coords" title="cogl_rectangle_with_texture_coords ()">cogl_rectangle_with_texture_coords</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-Primitives.html#cogl-rectangles-with-texture-coords" title="cogl_rectangles_with_texture_coords ()">cogl_rectangles_with_texture_coords</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-Primitives.html#cogl-rectangle-with-multitexture-coords" title="cogl_rectangle_with_multitexture_coords ()">cogl_rectangle_with_multitexture_coords</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="cogl-Primitives.html#cogl-polygon" title="cogl_polygon ()">cogl_polygon</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</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.functions_details"></a><h2>Functions</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="refsect3">
<a name="cogl-rectangle.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>x_1</p></td>
<td class="parameter_description"><p>X coordinate of the top-left corner</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_1</p></td>
<td class="parameter_description"><p>Y coordinate of the top-left corner</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_2</p></td>
<td class="parameter_description"><p>X coordinate of the bottom-right corner</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_2</p></td>
<td class="parameter_description"><p>Y coordinate of the bottom-right corner</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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="refsect3">
<a name="cogl-rectangles.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>verts</p></td>
<td class="parameter_description"><p> an array of vertices. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>n_rects</p></td>
<td class="parameter_description"><p>number of rectangles to draw</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-1.0">1.0</a></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="refsect3">
<a name="cogl-rectangle-with-texture-coords.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>x1</p></td>
<td class="parameter_description"><p>x coordinate upper left on screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y1</p></td>
<td class="parameter_description"><p>y coordinate upper left on screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x2</p></td>
<td class="parameter_description"><p>x coordinate lower right on screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y2</p></td>
<td class="parameter_description"><p>y coordinate lower right on screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tx1</p></td>
<td class="parameter_description"><p>x part of texture coordinate to use for upper left pixel</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ty1</p></td>
<td class="parameter_description"><p>y part of texture coordinate to use for upper left pixel</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tx2</p></td>
<td class="parameter_description"><p>x part of texture coordinate to use for lower right pixel</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ty2</p></td>
<td class="parameter_description"><p>y part of texture coordinate to use for left pixel</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-1.0">1.0</a></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="refsect3">
<a name="cogl-rectangles-with-texture-coords.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>verts</p></td>
<td class="parameter_description"><p> an array of vertices. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>n_rects</p></td>
<td class="parameter_description"><p>number of rectangles to draw</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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="refsect3">
<a name="cogl-rectangle-with-multitexture-coords.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>x1</p></td>
<td class="parameter_description"><p>x coordinate upper left on screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y1</p></td>
<td class="parameter_description"><p>y coordinate upper left on screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x2</p></td>
<td class="parameter_description"><p>x coordinate lower right on screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y2</p></td>
<td class="parameter_description"><p>y coordinate lower right on screen.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tex_coords</p></td>
<td class="parameter_description"><p> 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. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>tex_coords_len</p></td>
<td class="parameter_description"><p>The length of the tex_coords array. (e.g. for one layer
and one group of texture coordinates, this would be 4)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-1.0">1.0</a></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="refsect3">
<a name="cogl-polygon.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>vertices</p></td>
<td class="parameter_description"><p>An array of <a class="link" href="cogl-Textures.html#CoglTextureVertex" title="struct CoglTextureVertex"><span class="type">CoglTextureVertex</span></a> structs</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_vertices</p></td>
<td class="parameter_description"><p>The length of the vertices array</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>use_color</p></td>
<td class="parameter_description"><p><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</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="cogl-Primitives.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.