libcogl-doc 1.16.2-1 / usr / share / gtk-doc / html / cogl-2.0-experimental / cogl-2.0-experimental-SDL-Integration.html

This file is indexed.

/usr/share/gtk-doc/html/cogl-2.0-experimental/cogl-2.0-experimental-SDL-Integration.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SDL Integration</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Cogl 2.0 Reference Manual">
<link rel="up" href="cogl-integration.html" title="Binding and Integrating">
<link rel="prev" href="cogl-integration.html" title="Binding and Integrating">
<link rel="next" href="cogl-2.0-experimental-Main-loop-integration.html" title="Main loop integration">
<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-integration.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="cogl-integration.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 2.0 Reference Manual</th>
<td><a accesskey="n" href="cogl-2.0-experimental-Main-loop-integration.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-2.0-experimental-SDL-Integration.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#cogl-2.0-experimental-SDL-Integration.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="cogl-2.0-experimental-SDL-Integration"></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-SDL-Integration.top_of_page"></a>SDL Integration</span></h2>
<p>SDL Integration — Integration api for the Simple DirectMedia
                    Layer library.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="cogl-2.0-experimental-SDL-Integration.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="returnvalue">CoglContext</span></a> *       <a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-context-new" title="cogl_sdl_context_new ()">cogl_sdl_context_new</a>                (<em class="parameter"><code><span class="type">int</span> type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Exception-handling.html#CoglError" title="CoglError"><span class="type">CoglError</span></a> **error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-renderer-set-event-type" title="cogl_sdl_renderer_set_event_type ()">cogl_sdl_renderer_set_event_type</a>    (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> type</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-renderer-get-event-type" title="cogl_sdl_renderer_get_event_type ()">cogl_sdl_renderer_get_event_type</a>    (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-handle-event" title="cogl_sdl_handle_event ()">cogl_sdl_handle_event</a>               (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a> *context</code></em>,
                                                         <em class="parameter"><code><span class="type">SDL_Event</span> *event</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-idle" title="cogl_sdl_idle ()">cogl_sdl_idle</a>                       (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a> *context</code></em>);
<span class="returnvalue">SDL_Window</span> *        <a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-onscreen-get-window" title="cogl_sdl_onscreen_get_window ()">cogl_sdl_onscreen_get_window</a>        (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglOnscreen---The-Onscreen-Framebuffer-Interface.html#CoglOnscreen" title="CoglOnscreen"><span class="type">CoglOnscreen</span></a> *onscreen</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-SDL-Integration.description"></a><h2>Description</h2>
<p>
Cogl is a portable graphics api that can either be used standalone
or alternatively integrated with certain existing frameworks. This
api enables Cogl to be used in conjunction with the Simple
DirectMedia Layer library.
</p>
<p>
Using this API a typical SDL application would look something like
this:
</p>
<div class="informalexample"><pre class="programlisting">
MyAppData data;
CoglError *error = NULL;

data.ctx = cogl_sdl_context_new (SDL_USEREVENT, &amp;error);
if (!data.ctx)
  {
    fprintf (stderr, "Failed to create context: %s\n",
             error-&gt;message);
    return 1;
  }

my_application_setup (&amp;data);

data.redraw_queued = TRUE;
while (!data.quit)
  {
    while (!data.quit)
      {
        if (!SDL_PollEvent (&amp;event))
          {
            if (data.redraw_queued)
              break;

            cogl_sdl_idle (ctx);
            if (!SDL_WaitEvent (&amp;event))
              {
                fprintf (stderr, "Error waiting for SDL events");
                return 1;
              }
          }

         handle_event (&amp;data, &amp;event);
         cogl_sdl_handle_event (ctx, &amp;event);
       }

    data.redraw_queued = redraw (&amp;data);
  }
</pre></div>
<p>
</p>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-SDL-Integration.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="cogl-sdl-context-new"></a><h3>cogl_sdl_context_new ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="returnvalue">CoglContext</span></a> *       cogl_sdl_context_new                (<em class="parameter"><code><span class="type">int</span> type</code></em>,
                                                         <em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Exception-handling.html#CoglError" title="CoglError"><span class="type">CoglError</span></a> **error</code></em>);</pre>
<p>
This is a convenience function for creating a new <a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a> for
use with SDL and specifying what SDL user event type Cogl can use
as a way to interrupt <code class="function">SDL_WaitEvent()</code>.
</p>
<p>
This function is equivalent to the following code:
</p>
<div class="informalexample"><pre class="programlisting">
CoglRenderer *renderer = cogl_renderer_new ();
CoglDisplay *display;

cogl_renderer_set_winsys_id (renderer, COGL_WINSYS_ID_SDL);

cogl_sdl_renderer_set_event_type (renderer, type);

if (!cogl_renderer_connect (renderer, error))
  return NULL;

display = cogl_display_new (renderer, NULL);
if (!cogl_display_setup (display, error))
  return NULL;

return cogl_context_new (display, error);
</pre></div>
<p>
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>SDL applications are required to either use this API or
to manually create a <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> and call
<a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-renderer-set-event-type" title="cogl_sdl_renderer_set_event_type ()"><code class="function">cogl_sdl_renderer_set_event_type()</code></a>.</div>
<p>
</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>type</code></em> :</span></p></td>
<td>An SDL user event type between <code class="constant">SDL_USEREVENT</code> and
<code class="constant">SDL_NUMEVENTS</code> - 1</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A CoglError return location.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.0</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-sdl-renderer-set-event-type"></a><h3>cogl_sdl_renderer_set_event_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                cogl_sdl_renderer_set_event_type    (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> type</code></em>);</pre>
<p>
Tells Cogl what SDL user event type it can use as a way to
interrupt <code class="function">SDL_WaitEvent()</code> to ensure that <a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-handle-event" title="cogl_sdl_handle_event ()"><code class="function">cogl_sdl_handle_event()</code></a>
will be called in a finite amount of time.
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>This should only be called on an un-connected
<em class="parameter"><code>renderer</code></em>.</div>
<p>
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>For convenience most simple applications can use
<a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-context-new" title="cogl_sdl_context_new ()"><code class="function">cogl_sdl_context_new()</code></a> if they don't want to manually create
<a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> and <a class="link" href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#CoglDisplay" title="CoglDisplay"><span class="type">CoglDisplay</span></a> objects during
initialization.</div>
<p>
</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>renderer</code></em> :</span></p></td>
<td>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>An SDL user event type between <code class="constant">SDL_USEREVENT</code> and
<code class="constant">SDL_NUMEVENTS</code> - 1</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.0</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-sdl-renderer-get-event-type"></a><h3>cogl_sdl_renderer_get_event_type ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 cogl_sdl_renderer_get_event_type    (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a> *renderer</code></em>);</pre>
<p>
Queries what SDL user event type Cogl is using as a way to
interrupt <code class="function">SDL_WaitEvent()</code>. This is set either using
cogl_sdl_context_new or by using
<a class="link" href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-renderer-set-event-type" title="cogl_sdl_renderer_set_event_type ()"><code class="function">cogl_sdl_renderer_set_event_type()</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>renderer</code></em> :</span></p></td>
<td>A <a class="link" href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#CoglRenderer" title="CoglRenderer"><span class="type">CoglRenderer</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.0</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-sdl-handle-event"></a><h3>cogl_sdl_handle_event ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                cogl_sdl_handle_event               (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a> *context</code></em>,
                                                         <em class="parameter"><code><span class="type">SDL_Event</span> *event</code></em>);</pre>
<p>
Passes control to Cogl so that it may dispatch any internal event
callbacks in response to the given SDL <em class="parameter"><code>event</code></em>. This function must
be called for every SDL event.
</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>context</code></em> :</span></p></td>
<td>A <a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
<td>An SDL event</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.0</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-sdl-idle"></a><h3>cogl_sdl_idle ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                cogl_sdl_idle                       (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a> *context</code></em>);</pre>
<p>
Notifies Cogl that the application is idle and about to call
<code class="function">SDL_WaitEvent()</code>. Cogl may use this to run low priority book keeping
tasks.
</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>context</code></em> :</span></p></td>
<td>A <a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.0</p>
<p class="stability">Stability Level: Unstable</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-sdl-onscreen-get-window"></a><h3>cogl_sdl_onscreen_get_window ()</h3>
<pre class="programlisting"><span class="returnvalue">SDL_Window</span> *        cogl_sdl_onscreen_get_window        (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-CoglOnscreen---The-Onscreen-Framebuffer-Interface.html#CoglOnscreen" title="CoglOnscreen"><span class="type">CoglOnscreen</span></a> *onscreen</code></em>);</pre>
<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>onscreen</code></em> :</span></p></td>
<td>A <a class="link" href="cogl-2.0-experimental-CoglOnscreen---The-Onscreen-Framebuffer-Interface.html#CoglOnscreen" title="CoglOnscreen"><span class="type">CoglOnscreen</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the underlying SDL_Window associated with an onscreen framebuffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.0</p>
<p class="stability">Stability Level: Unstable</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.