/usr/share/gtk-doc/html/cogl-2.0-experimental/cogl-2.0-experimental-SDL-Integration.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 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 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 | <!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: 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-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.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-SDL-Integration.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-integration.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="cogl-integration.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="cogl-2.0-experimental-Main-loop-integration.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-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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="cogl-2.0-experimental-SDL-Integration.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">
<a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="returnvalue">CoglContext</span></a> *
</td>
<td class="function_name">
<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> <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-SDL-Integration.html#cogl-sdl-renderer-set-event-type" title="cogl_sdl_renderer_set_event_type ()">cogl_sdl_renderer_set_event_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<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> <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-SDL-Integration.html#cogl-sdl-handle-event" title="cogl_sdl_handle_event ()">cogl_sdl_handle_event</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-SDL-Integration.html#cogl-sdl-idle" title="cogl_sdl_idle ()">cogl_sdl_idle</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">SDL_Window</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</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">
<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
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37</pre></td>
<td class="listing_code"><pre class="programlisting">MyAppData data<span class="gtkdoc opt">;</span>
CoglError <span class="gtkdoc opt">*</span>error <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span>
data<span class="gtkdoc opt">.</span>ctx <span class="gtkdoc opt">=</span> <span class="function"><a href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-context-new">cogl_sdl_context_new</a></span> <span class="gtkdoc opt">(</span>SDL_USEREVENT<span class="gtkdoc opt">, &</span>error<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(!</span>data<span class="gtkdoc opt">.</span>ctx<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
<span class="function">fprintf</span> <span class="gtkdoc opt">(</span>stderr<span class="gtkdoc opt">,</span> <span class="string">"Failed to create context: %s</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="gtkdoc opt">,</span>
error<span class="gtkdoc opt">-></span>message<span class="gtkdoc opt">);</span>
<span class="keyword">return</span> <span class="number">1</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="function">my_application_setup</span> <span class="gtkdoc opt">(&</span>data<span class="gtkdoc opt">);</span>
data<span class="gtkdoc opt">.</span>redraw_queued <span class="gtkdoc opt">=</span> TRUE<span class="gtkdoc opt">;</span>
<span class="keyword">while</span> <span class="gtkdoc opt">(!</span>data<span class="gtkdoc opt">.</span>quit<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
<span class="keyword">while</span> <span class="gtkdoc opt">(!</span>data<span class="gtkdoc opt">.</span>quit<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(!</span><span class="function">SDL_PollEvent</span> <span class="gtkdoc opt">(&</span>event<span class="gtkdoc opt">))</span>
<span class="gtkdoc opt">{</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>data<span class="gtkdoc opt">.</span>redraw_queued<span class="gtkdoc opt">)</span>
<span class="keyword">break</span><span class="gtkdoc opt">;</span>
<span class="function"><a href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-idle">cogl_sdl_idle</a></span> <span class="gtkdoc opt">(</span>ctx<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(!</span><span class="function">SDL_WaitEvent</span> <span class="gtkdoc opt">(&</span>event<span class="gtkdoc opt">))</span>
<span class="gtkdoc opt">{</span>
<span class="function">fprintf</span> <span class="gtkdoc opt">(</span>stderr<span class="gtkdoc opt">,</span> <span class="string">"Error waiting for SDL events"</span><span class="gtkdoc opt">);</span>
<span class="keyword">return</span> <span class="number">1</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span>
<span class="gtkdoc opt">}</span>
<span class="function">handle_event</span> <span class="gtkdoc opt">(&</span>data<span class="gtkdoc opt">, &</span>event<span class="gtkdoc opt">);</span>
<span class="function"><a href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-handle-event">cogl_sdl_handle_event</a></span> <span class="gtkdoc opt">(</span>ctx<span class="gtkdoc opt">, &</span>event<span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span>
data<span class="gtkdoc opt">.</span>redraw_queued <span class="gtkdoc opt">=</span> <span class="function">redraw</span> <span class="gtkdoc opt">(&</span>data<span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-SDL-Integration.functions_details"></a><h2>Functions</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">
<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</pre></td>
<td class="listing_code"><pre class="programlisting">CoglRenderer <span class="gtkdoc opt">*</span>renderer <span class="gtkdoc opt">=</span> <span class="function"><a href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-new">cogl_renderer_new</a></span> <span class="gtkdoc opt">();</span>
CoglDisplay <span class="gtkdoc opt">*</span>display<span class="gtkdoc opt">;</span>
<span class="function"><a href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-set-winsys-id">cogl_renderer_set_winsys_id</a></span> <span class="gtkdoc opt">(</span>renderer<span class="gtkdoc opt">,</span> COGL_WINSYS_ID_SDL<span class="gtkdoc opt">);</span>
<span class="function"><a href="cogl-2.0-experimental-SDL-Integration.html#cogl-sdl-renderer-set-event-type">cogl_sdl_renderer_set_event_type</a></span> <span class="gtkdoc opt">(</span>renderer<span class="gtkdoc opt">,</span> type<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(!</span><span class="function"><a href="cogl-2.0-experimental-CoglRenderer---Connect-to-a-backend-renderer.html#cogl-renderer-connect">cogl_renderer_connect</a></span> <span class="gtkdoc opt">(</span>renderer<span class="gtkdoc opt">,</span> error<span class="gtkdoc opt">))</span>
<span class="keyword">return</span> NULL<span class="gtkdoc opt">;</span>
display <span class="gtkdoc opt">=</span> <span class="function"><a href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#cogl-display-new">cogl_display_new</a></span> <span class="gtkdoc opt">(</span>renderer<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(!</span><span class="function"><a href="cogl-2.0-experimental-CoglDisplay---Setup-a-display-pipeline.html#cogl-display-setup">cogl_display_setup</a></span> <span class="gtkdoc opt">(</span>display<span class="gtkdoc opt">,</span> error<span class="gtkdoc opt">))</span>
<span class="keyword">return</span> NULL<span class="gtkdoc opt">;</span>
<span class="keyword">return</span> <span class="function"><a href="cogl-2.0-experimental-The-Top-Level-Context.html#cogl-context-new">cogl_context_new</a></span> <span class="gtkdoc opt">(</span>display<span class="gtkdoc opt">,</span> error<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="note">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>
<div class="refsect3">
<a name="cogl-sdl-context-new.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>type</p></td>
<td class="parameter_description">
<p>An SDL user event type between <code class="constant">SDL_USEREVENT</code> and</p>
<code class="constant">SDL_NUMEVENTS</code> - 1</td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A CoglError return location.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.0</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></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>
<div class="note">This should only be called on an un-connected
<em class="parameter"><code>renderer</code></em>.</div>
<div class="note">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>
<div class="refsect3">
<a name="cogl-sdl-renderer-set-event-type.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>renderer</p></td>
<td class="parameter_description"><p>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></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description">
<p>An SDL user event type between <code class="constant">SDL_USEREVENT</code> and</p>
<code class="constant">SDL_NUMEVENTS</code> - 1</td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.0</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></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="refsect3">
<a name="cogl-sdl-renderer-get-event-type.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>renderer</p></td>
<td class="parameter_description"><p>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></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 2.0</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></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="refsect3">
<a name="cogl-sdl-handle-event.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>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>An SDL event</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.0</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></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="refsect3">
<a name="cogl-sdl-idle.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>context</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#CoglContext" title="CoglContext"><span class="type">CoglContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 2.0</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></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="refsect3">
<a name="cogl-sdl-onscreen-get-window.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>onscreen</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-CoglOnscreen---The-Onscreen-Framebuffer-Interface.html#CoglOnscreen" title="CoglOnscreen"><span class="type">CoglOnscreen</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-sdl-onscreen-get-window.returns"></a><h4>Returns</h4>
<p> the underlying SDL_Window associated with an onscreen framebuffer.</p>
</div>
<p class="since">Since: 2.0</p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-SDL-Integration.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|