libcogl-doc 1.22.2-2 / usr / share / gtk-doc / html / cogl-2.0-experimental / cogl-2.0-experimental-The-Object-Interface.html

This file is indexed.

/usr/share/gtk-doc/html/cogl-2.0-experimental/cogl-2.0-experimental-The-Object-Interface.html is in libcogl-doc 1.22.2-2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>The Object Interface: Cogl 2.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Cogl 2.0 Reference Manual">
<link rel="up" href="cogl-general-apis.html" title="General API concepts">
<link rel="prev" href="cogl-general-apis.html" title="General API concepts">
<link rel="next" href="cogl-2.0-experimental-Exception-handling.html" title="Exception handling">
<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-2.0-experimental-The-Object-Interface.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="cogl-general-apis.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="cogl-general-apis.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="cogl-2.0-experimental-Exception-handling.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="cogl-2.0-experimental-The-Object-Interface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="cogl-2.0-experimental-The-Object-Interface.top_of_page"></a>The Object Interface</span></h2>
<p>The Object Interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="cogl-2.0-experimental-The-Object-Interface.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-2.0-experimental-The-Object-Interface.html#cogl-object-ref" title="cogl_object_ref ()">cogl_object_ref</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-2.0-experimental-The-Object-Interface.html#cogl-object-unref" title="cogl_object_unref ()">cogl_object_unref</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-2.0-experimental-The-Object-Interface.html#cogl-object-get-user-data" title="cogl_object_get_user_data ()">cogl_object_get_user_data</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-2.0-experimental-The-Object-Interface.html#cogl-object-set-user-data" title="cogl_object_set_user_data ()">cogl_object_set_user_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-The-Object-Interface.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject">CoglObject</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataKey" title="CoglUserDataKey">CoglUserDataKey</a></td>
</tr>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataDestroyCallback" title="CoglUserDataDestroyCallback">CoglUserDataDestroyCallback</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-The-Object-Interface.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-The-Object-Interface.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cogl-object-ref"></a><h3>cogl_object_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *
cogl_object_ref (<em class="parameter"><code><span class="type">void</span> *object</code></em>);</pre>
<p>Increases the reference count of <em class="parameter"><code>object</code></em>
 by 1</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="cogl-object-ref.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>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-object-ref.returns"></a><h4>Returns</h4>
<p> the <em class="parameter"><code>object</code></em>
, with its reference count increased</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-object-unref"></a><h3>cogl_object_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_object_unref (<em class="parameter"><code><span class="type">void</span> *object</code></em>);</pre>
<p>Drecreases the reference count of <em class="parameter"><code>object</code></em>
 by 1; if the reference
count reaches 0, the resources allocated by <em class="parameter"><code>object</code></em>
 will be freed</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="cogl-object-unref.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>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cogl-object-get-user-data"></a><h3>cogl_object_get_user_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *
cogl_object_get_user_data (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a> *object</code></em>,
                           <em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataKey" title="CoglUserDataKey"><span class="type">CoglUserDataKey</span></a> *key</code></em>);</pre>
<p>Finds the user data previously associated with <em class="parameter"><code>object</code></em>
 using
the given <em class="parameter"><code>key</code></em>
. If no user data has been associated with <em class="parameter"><code>object</code></em>

for the given <em class="parameter"><code>key</code></em>
 this function returns NULL.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="cogl-object-get-user-data.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>object</p></td>
<td class="parameter_description"><p>The object with associated private data to query</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The address of a <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataKey" title="CoglUserDataKey"><span class="type">CoglUserDataKey</span></a> which provides a unique value
with which to index the private data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-object-get-user-data.returns"></a><h4>Returns</h4>
<p> The user data previously associated
with <em class="parameter"><code>object</code></em>
using the given <em class="parameter"><code>key</code></em>
; or <code class="literal">NULL</code> if no associated
data is found. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-object-set-user-data"></a><h3>cogl_object_set_user_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_object_set_user_data (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a> *object</code></em>,
                           <em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataKey" title="CoglUserDataKey"><span class="type">CoglUserDataKey</span></a> *key</code></em>,
                           <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
                           <em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataDestroyCallback" title="CoglUserDataDestroyCallback"><span class="type">CoglUserDataDestroyCallback</span></a> destroy</code></em>);</pre>
<p>Associates some private <em class="parameter"><code>user_data</code></em>
 with a given <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a>. To
later remove the association call <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#cogl-object-set-user-data" title="cogl_object_set_user_data ()"><code class="function">cogl_object_set_user_data()</code></a> with
the same <em class="parameter"><code>key</code></em>
 but NULL for the <em class="parameter"><code>user_data</code></em>
.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="cogl-object-set-user-data.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>object</p></td>
<td class="parameter_description"><p>The object to associate private data with</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The address of a <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataKey" title="CoglUserDataKey"><span class="type">CoglUserDataKey</span></a> which provides a unique value
with which to index the private data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>The data to associate with the given object,
or <code class="literal">NULL</code> to remove a previous association.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataDestroyCallback" title="CoglUserDataDestroyCallback"><span class="type">CoglUserDataDestroyCallback</span></a> to call if the object is
destroyed or if the association is removed by later setting
<code class="literal">NULL</code> data for the same key.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-The-Object-Interface.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CoglObject"></a><h3>CoglObject</h3>
<pre class="programlisting">typedef struct _CoglObject CoglObject;</pre>
<p>Ref Func: cogl_object_ref
Unref Func: cogl_object_unref
Set Value Func: cogl_object_value_set_object
Get Value Func: cogl_object_value_get_object</p>
</div>
<hr>
<div class="refsect2">
<a name="CoglUserDataKey"></a><h3>CoglUserDataKey</h3>
<pre class="programlisting">typedef struct {
  int unused;
} CoglUserDataKey;
</pre>
<p>A <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataKey" title="CoglUserDataKey"><span class="type">CoglUserDataKey</span></a> is used to declare a key for attaching data to a
<a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a> using cogl_object_set_user_data. The typedef only exists as a
formality to make code self documenting since only the unique address of a
<a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataKey" title="CoglUserDataKey"><span class="type">CoglUserDataKey</span></a> is used.</p>
<p>Typically you would declare a static <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglUserDataKey" title="CoglUserDataKey"><span class="type">CoglUserDataKey</span></a> and set private data
on an object something like this:</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static</span> CoglUserDataKey path_private_key<span class="gtkdoc opt">;</span>

<span class="gtkdoc kwb">static void</span>
<span class="function">destroy_path_private_cb</span> <span class="gtkdoc opt">(</span><span class="gtkdoc kwb">void</span> <span class="gtkdoc opt">*</span>data<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
  <span class="function">g_free</span> <span class="gtkdoc opt">(</span>data<span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>

<span class="gtkdoc kwb">static void</span>
<span class="function">my_path_set_data</span> <span class="gtkdoc opt">(</span>CoglPath <span class="gtkdoc opt">*</span>path<span class="gtkdoc opt">,</span> <span class="gtkdoc kwb">void</span> <span class="gtkdoc opt">*</span>data<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
  <span class="function"><a href="cogl-2.0-experimental-The-Object-Interface.html#cogl-object-set-user-data">cogl_object_set_user_data</a></span> <span class="gtkdoc opt">(</span><span class="function">COGL_OBJECT</span> <span class="gtkdoc opt">(</span>path<span class="gtkdoc opt">),</span>
                             <span class="gtkdoc opt">&amp;</span>private_key<span class="gtkdoc opt">,</span>
                             data<span class="gtkdoc opt">,</span>
                             destroy_path_private_cb<span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<div class="refsect3">
<a name="CoglUserDataKey.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="CoglUserDataKey.unused"></a>unused</code></em>;</p></td>
<td class="struct_member_description"><p>ignored.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="CoglUserDataDestroyCallback"></a><h3>CoglUserDataDestroyCallback</h3>
<pre class="programlisting">typedef GDestroyNotify CoglUserDataDestroyCallback;
</pre>
<p>When associating private data with a <a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a> a callback can be
given which will be called either if the object is destroyed or if
<a class="link" href="cogl-2.0-experimental-The-Object-Interface.html#cogl-object-set-user-data" title="cogl_object_set_user_data ()"><code class="function">cogl_object_set_user_data()</code></a> is called with NULL user_data for the
same key.</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-1.4">1.4</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.