/usr/share/gtk-doc/html/cogl-2.0-experimental/cogl-2.0-experimental-Depth-State.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 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Depth State: 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-pipeline-apis.html" title="Setting Up A GPU Pipeline">
<link rel="prev" href="cogl-2.0-experimental-Pipeline.html" title="Pipeline">
<link rel="next" href="cogl-2.0-experimental-Shader-snippets.html" title="Shader snippets">
<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-Depth-State.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-pipeline-apis.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="cogl-2.0-experimental-Pipeline.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="cogl-2.0-experimental-Shader-snippets.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-Depth-State"></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-Depth-State.top_of_page"></a>Depth State</span></h2>
<p>Depth State — Functions for describing the depth testing
state of your GPU.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="cogl-2.0-experimental-Depth-State.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-Depth-State.html#cogl-depth-state-init" title="cogl_depth_state_init ()">cogl_depth_state_init</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-Depth-State.html#cogl-depth-state-set-test-enabled" title="cogl_depth_state_set_test_enabled ()">cogl_depth_state_set_test_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="returnvalue">CoglBool</span></a>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-get-test-enabled" title="cogl_depth_state_get_test_enabled ()">cogl_depth_state_get_test_enabled</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-Depth-State.html#cogl-depth-state-set-test-function" title="cogl_depth_state_set_test_function ()">cogl_depth_state_set_test_function</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthTestFunction" title="enum CoglDepthTestFunction"><span class="returnvalue">CoglDepthTestFunction</span></a>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-get-test-function" title="cogl_depth_state_get_test_function ()">cogl_depth_state_get_test_function</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-Depth-State.html#cogl-depth-state-set-write-enabled" title="cogl_depth_state_set_write_enabled ()">cogl_depth_state_set_write_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="returnvalue">CoglBool</span></a>
</td>
<td class="function_name">
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-get-write-enabled" title="cogl_depth_state_get_write_enabled ()">cogl_depth_state_get_write_enabled</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-Depth-State.html#cogl-depth-state-set-range" title="cogl_depth_state_set_range ()">cogl_depth_state_set_range</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-Depth-State.html#cogl-depth-state-get-range" title="cogl_depth_state_get_range ()">cogl_depth_state_get_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-Depth-State.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-Depth-State.html#CoglDepthState" title="CoglDepthState">CoglDepthState</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthTestFunction" title="enum CoglDepthTestFunction">CoglDepthTestFunction</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-Depth-State.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-Depth-State.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cogl-depth-state-init"></a><h3>cogl_depth_state_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_depth_state_init (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>);</pre>
<p>Initializes the members of <em class="parameter"><code>state</code></em>
to their default values.</p>
<p>You should never pass an un initialized <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> structure
to <a class="link" href="cogl-2.0-experimental-Pipeline.html#cogl-pipeline-set-depth-state" title="cogl_pipeline_set_depth_state ()"><code class="function">cogl_pipeline_set_depth_state()</code></a>.</p>
<div class="refsect3">
<a name="cogl-depth-state-init.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> struct</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-depth-state-set-test-enabled"></a><h3>cogl_depth_state_set_test_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_depth_state_set_test_enabled (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="type">CoglBool</span></a> enable</code></em>);</pre>
<p>Enables or disables depth testing according to the value of
<em class="parameter"><code>enable</code></em>
.</p>
<p>If depth testing is enable then the <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthTestFunction" title="enum CoglDepthTestFunction"><span class="type">CoglDepthTestFunction</span></a> set
using <a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-set-test-function" title="cogl_depth_state_set_test_function ()"><code class="function">cogl_depth_state_set_test_function()</code></a> us used to evaluate
the depth value of incoming fragments against the corresponding
value stored in the current depth buffer, and if the test passes
then the fragments depth value is used to update the depth buffer.
(unless you have disabled depth writing via
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-set-write-enabled" title="cogl_depth_state_set_write_enabled ()"><code class="function">cogl_depth_state_set_write_enabled()</code></a>)</p>
<p>By default depth testing is disabled.</p>
<p>NB: this won't directly affect the state of the GPU. You have
to then set the state on a <a class="link" href="cogl-2.0-experimental-Pipeline.html#CoglPipeline" title="CoglPipeline"><span class="type">CoglPipeline</span></a> using
<a class="link" href="cogl-2.0-experimental-Pipeline.html#cogl-pipeline-set-depth-state" title="cogl_pipeline_set_depth_state ()"><code class="function">cogl_pipeline_set_depth_state()</code></a></p>
<div class="refsect3">
<a name="cogl-depth-state-set-test-enabled.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> struct</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enable</p></td>
<td class="parameter_description"><p>The enable state you want</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-depth-state-get-test-enabled"></a><h3>cogl_depth_state_get_test_enabled ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="returnvalue">CoglBool</span></a>
cogl_depth_state_get_test_enabled (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>);</pre>
<p>Gets the current depth test enabled state as previously set by
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-set-test-enabled" title="cogl_depth_state_set_test_enabled ()"><code class="function">cogl_depth_state_set_test_enabled()</code></a>.</p>
<div class="refsect3">
<a name="cogl-depth-state-get-test-enabled.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> struct</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-depth-state-get-test-enabled.returns"></a><h4>Returns</h4>
<p> The pipeline's current depth test enabled state.</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>
<hr>
<div class="refsect2">
<a name="cogl-depth-state-set-test-function"></a><h3>cogl_depth_state_set_test_function ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_depth_state_set_test_function (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthTestFunction" title="enum CoglDepthTestFunction"><span class="type">CoglDepthTestFunction</span></a> function</code></em>);</pre>
<p>Sets the <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthTestFunction" title="enum CoglDepthTestFunction"><span class="type">CoglDepthTestFunction</span></a> used to compare the depth value of
an incoming fragment against the corresponding value in the current
depth buffer.</p>
<p>By default the depth test function is <a class="link" href="cogl-2.0-experimental-Depth-State.html#COGL-DEPTH-TEST-FUNCTION-LESS:CAPS"><code class="literal">COGL_DEPTH_TEST_FUNCTION_LESS</code></a></p>
<p>NB: this won't directly affect the state of the GPU. You have
to then set the state on a <a class="link" href="cogl-2.0-experimental-Pipeline.html#CoglPipeline" title="CoglPipeline"><span class="type">CoglPipeline</span></a> using
<a class="link" href="cogl-2.0-experimental-Pipeline.html#cogl-pipeline-set-depth-state" title="cogl_pipeline_set_depth_state ()"><code class="function">cogl_pipeline_set_depth_state()</code></a></p>
<div class="refsect3">
<a name="cogl-depth-state-set-test-function.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> struct</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>function</p></td>
<td class="parameter_description"><p>The <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthTestFunction" title="enum CoglDepthTestFunction"><span class="type">CoglDepthTestFunction</span></a> to set</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-depth-state-get-test-function"></a><h3>cogl_depth_state_get_test_function ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthTestFunction" title="enum CoglDepthTestFunction"><span class="returnvalue">CoglDepthTestFunction</span></a>
cogl_depth_state_get_test_function (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>);</pre>
<p>Gets the current depth test enable state as previously set via
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-set-test-enabled" title="cogl_depth_state_set_test_enabled ()"><code class="function">cogl_depth_state_set_test_enabled()</code></a>.</p>
<div class="refsect3">
<a name="cogl-depth-state-get-test-function.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> struct</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-depth-state-get-test-function.returns"></a><h4>Returns</h4>
<p> The current depth test enable state.</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>
<hr>
<div class="refsect2">
<a name="cogl-depth-state-set-write-enabled"></a><h3>cogl_depth_state_set_write_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_depth_state_set_write_enabled (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>,
<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="type">CoglBool</span></a> enable</code></em>);</pre>
<p>Enables or disables depth buffer writing according to the value of
<em class="parameter"><code>enable</code></em>
. Normally when depth testing is enabled and the comparison
between a fragment's depth value and the corresponding depth buffer
value passes then the fragment's depth is written to the depth
buffer unless writing is disabled here.</p>
<p>By default depth writing is enabled</p>
<p>NB: this won't directly affect the state of the GPU. You have
to then set the state on a <a class="link" href="cogl-2.0-experimental-Pipeline.html#CoglPipeline" title="CoglPipeline"><span class="type">CoglPipeline</span></a> using
<a class="link" href="cogl-2.0-experimental-Pipeline.html#cogl-pipeline-set-depth-state" title="cogl_pipeline_set_depth_state ()"><code class="function">cogl_pipeline_set_depth_state()</code></a></p>
<div class="refsect3">
<a name="cogl-depth-state-set-write-enabled.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> struct</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enable</p></td>
<td class="parameter_description"><p>The enable state you want</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-depth-state-get-write-enabled"></a><h3>cogl_depth_state_get_write_enabled ()</h3>
<pre class="programlisting"><a class="link" href="cogl-2.0-experimental-Common-Types.html#CoglBool" title="CoglBool"><span class="returnvalue">CoglBool</span></a>
cogl_depth_state_get_write_enabled (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>);</pre>
<p>Gets the depth writing enable state as set by the corresponding
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-set-write-enabled" title="cogl_depth_state_set_write_enabled ()"><code class="function">cogl_depth_state_set_write_enabled()</code></a>.</p>
<div class="refsect3">
<a name="cogl-depth-state-get-write-enabled.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> struct</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cogl-depth-state-get-write-enabled.returns"></a><h4>Returns</h4>
<p> The current depth writing enable state</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>
<hr>
<div class="refsect2">
<a name="cogl-depth-state-set-range"></a><h3>cogl_depth_state_set_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_depth_state_set_range (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>,
<em class="parameter"><code><span class="type">float</span> near_val</code></em>,
<em class="parameter"><code><span class="type">float</span> far_val</code></em>);</pre>
<p>Sets the range to map depth values in normalized device coordinates
to before writing out to a depth buffer.</p>
<p>After your geometry has be transformed, clipped and had perspective
division applied placing it in normalized device
coordinates all depth values between the near and far z clipping
planes are in the range -1 to 1. Before writing any depth value to
the depth buffer though the value is mapped into the range [0, 1].</p>
<p>With this function you can change the range which depth values are
mapped too although the range must still lye within the range [0,
1].</p>
<p>If your driver does not support this feature (for example you are
using GLES 1 drivers) then if you don't use the default range
values you will get an error reported when calling
<a class="link" href="cogl-2.0-experimental-Pipeline.html#cogl-pipeline-set-depth-state" title="cogl_pipeline_set_depth_state ()"><code class="function">cogl_pipeline_set_depth_state()</code></a>. You can check ahead of time for
the <a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#COGL-FEATURE-ID-DEPTH-RANGE:CAPS"><code class="literal">COGL_FEATURE_ID_DEPTH_RANGE</code></a> feature with
<a class="link" href="cogl-2.0-experimental-The-Top-Level-Context.html#cogl-has-feature" title="cogl_has_feature ()"><code class="function">cogl_has_feature()</code></a> to know if this function will succeed.</p>
<p>By default normalized device coordinate depth values are mapped to
the full range of depth buffer values, [0, 1].</p>
<p>NB: this won't directly affect the state of the GPU. You have
to then set the state on a <a class="link" href="cogl-2.0-experimental-Pipeline.html#CoglPipeline" title="CoglPipeline"><span class="type">CoglPipeline</span></a> using
<a class="link" href="cogl-2.0-experimental-Pipeline.html#cogl-pipeline-set-depth-state" title="cogl_pipeline_set_depth_state ()"><code class="function">cogl_pipeline_set_depth_state()</code></a>.</p>
<div class="refsect3">
<a name="cogl-depth-state-set-range.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>near_val</p></td>
<td class="parameter_description"><p>The near component of the desired depth range which will be
clamped to the range [0, 1]</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>far_val</p></td>
<td class="parameter_description"><p>The far component of the desired depth range which will be
clamped to the range [0, 1]</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-depth-state-get-range"></a><h3>cogl_depth_state_get_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cogl_depth_state_get_range (<em class="parameter"><code><a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> *state</code></em>,
<em class="parameter"><code><span class="type">float</span> *near_val</code></em>,
<em class="parameter"><code><span class="type">float</span> *far_val</code></em>);</pre>
<p>Gets the current range to which normalized depth values are mapped
before writing to the depth buffer. This corresponds to the range
set with <a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-set-range" title="cogl_depth_state_set_range ()"><code class="function">cogl_depth_state_set_range()</code></a>.</p>
<div class="refsect3">
<a name="cogl-depth-state-get-range.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>state</p></td>
<td class="parameter_description"><p>A <a class="link" href="cogl-2.0-experimental-Depth-State.html#CoglDepthState" title="CoglDepthState"><span class="type">CoglDepthState</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>near_val</p></td>
<td class="parameter_description"><p>A pointer to store the near component of the depth range</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>far_val</p></td>
<td class="parameter_description"><p>A pointer to store the far component of the depth range</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>
</div>
<div class="refsect1">
<a name="cogl-2.0-experimental-Depth-State.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CoglDepthState"></a><h3>CoglDepthState</h3>
<pre class="programlisting">typedef struct {
} CoglDepthState;
</pre>
<p class="since">Since: 2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="CoglDepthTestFunction"></a><h3>enum CoglDepthTestFunction</h3>
<p>When using depth testing one of these functions is used to compare
the depth of an incoming fragment against the depth value currently
stored in the depth buffer. The function is changed using
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-set-test-function" title="cogl_depth_state_set_test_function ()"><code class="function">cogl_depth_state_set_test_function()</code></a>.</p>
<p>The test is only done when depth testing is explicitly enabled. (See
<a class="link" href="cogl-2.0-experimental-Depth-State.html#cogl-depth-state-set-test-enabled" title="cogl_depth_state_set_test_enabled ()"><code class="function">cogl_depth_state_set_test_enabled()</code></a>)</p>
<div class="refsect3">
<a name="CoglDepthTestFunction.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="COGL-DEPTH-TEST-FUNCTION-NEVER:CAPS"></a>COGL_DEPTH_TEST_FUNCTION_NEVER</p></td>
<td class="enum_member_description">
<p>Never passes.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-DEPTH-TEST-FUNCTION-LESS:CAPS"></a>COGL_DEPTH_TEST_FUNCTION_LESS</p></td>
<td class="enum_member_description">
<p>Passes if the fragment's depth
value is less than the value currently in the depth buffer.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-DEPTH-TEST-FUNCTION-EQUAL:CAPS"></a>COGL_DEPTH_TEST_FUNCTION_EQUAL</p></td>
<td class="enum_member_description">
<p>Passes if the fragment's depth
value is equal to the value currently in the depth buffer.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-DEPTH-TEST-FUNCTION-LEQUAL:CAPS"></a>COGL_DEPTH_TEST_FUNCTION_LEQUAL</p></td>
<td class="enum_member_description">
<p>Passes if the fragment's depth
value is less or equal to the value currently in the depth buffer.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-DEPTH-TEST-FUNCTION-GREATER:CAPS"></a>COGL_DEPTH_TEST_FUNCTION_GREATER</p></td>
<td class="enum_member_description">
<p>Passes if the fragment's depth
value is greater than the value currently in the depth buffer.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-DEPTH-TEST-FUNCTION-NOTEQUAL:CAPS"></a>COGL_DEPTH_TEST_FUNCTION_NOTEQUAL</p></td>
<td class="enum_member_description">
<p>Passes if the fragment's depth
value is not equal to the value currently in the depth buffer.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-DEPTH-TEST-FUNCTION-GEQUAL:CAPS"></a>COGL_DEPTH_TEST_FUNCTION_GEQUAL</p></td>
<td class="enum_member_description">
<p>Passes if the fragment's depth
value greater than or equal to the value currently in the depth buffer.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-DEPTH-TEST-FUNCTION-ALWAYS:CAPS"></a>COGL_DEPTH_TEST_FUNCTION_ALWAYS</p></td>
<td class="enum_member_description">
<p>Always passes.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|