<div class="refentry" id="glBeginConditionalRender">

<div class="titlepage"></div>

<div class="refnamediv">

<h2>Name</h2>

<p>glBeginConditionalRender — start conditional rendering</p>

</div>

<div class="refsynopsisdiv">

<h2>C Specification</h2>

<div class="funcsynopsis">

<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">

<tr>

<td>

<code class="funcdef">void <strong class="fsfunc">glBeginConditionalRender</strong>(</code>

</td>

<td>GLuint <var class="pdparam">id</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLenum <var class="pdparam">mode</var><code>)</code>;</td>

</tr>

</table>

<div class="funcprototype-spacer"> </div>

</div>

<div class="funcsynopsis">

<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">

<tr>

<td>

<code class="funcdef">void <strong class="fsfunc">glEndConditionalRender</strong>(</code>

</td>

<td><var class="pdparam">void</var><code>)</code>;</td>

</tr>

</table>

<div class="funcprototype-spacer"> </div>

</div>

</div>

<div class="refsect1" id="parameters">

<h2>Parameters for <code class="function">glBeginConditionalRender</code></h2>

<div class="variablelist">

<dl class="variablelist">

<dt>

<span class="term">

<em class="parameter">

<code>id</code>

</em>

</span>

</dt>

<dd>

<p>

Specifies the name of an occlusion query object whose results are used to determine if the rendering commands are discarded.

</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>mode</code>

</em>

</span>

</dt>

<dd>

<p>

Specifies how <code class="function">glBeginConditionalRender</code> interprets the results of the occlusion query.

</p>

</dd>

</dl>

</div>

</div>

<div class="refsect1" id="description">

<h2>Description</h2>

<p>

Conditional rendering is started using <code class="function">glBeginConditionalRender</code> and ended using <code class="function">glEndConditionalRender</code>.

During conditional rendering, all vertex array commands, as well as <a class="citerefentry" href="glClear"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a> and

<a class="citerefentry" href="glClearBuffer"><span class="citerefentry"><span class="refentrytitle">glClearBuffer</span></span></a> have no effect if the (<code class="constant">GL_SAMPLES_PASSED</code>) result

of the query object <em class="parameter"><code>id</code></em> is zero, or if the (<code class="constant">GL_ANY_SAMPLES_PASSED</code>) result is <code class="constant">GL_FALSE</code>.

The results of commands setting the current vertex state, such as <a class="citerefentry" href="glVertexAttrib"><span class="citerefentry"><span class="refentrytitle">glVertexAttrib</span></span></a> are

undefined. If the (<code class="constant">GL_SAMPLES_PASSED</code>) result is non-zero or if the (<code class="constant">GL_ANY_SAMPLES_PASSED</code>) result is

<code class="constant">GL_TRUE</code>, such commands are not discarded. The <em class="parameter"><code>id</code></em> parameter to <code class="function">glBeginConditionalRender</code>

must be the name of a query object previously returned from a call to <a class="citerefentry" href="glGenQueries"><span class="citerefentry"><span class="refentrytitle">glGenQueries</span></span></a>.

<em class="parameter"><code>mode</code></em> specifies how the results of the query object are to be interpreted. If <em class="parameter"><code>mode</code></em> is

<code class="constant">GL_QUERY_WAIT</code>, the GL waits for the results of the query to be available and then uses the results to determine if subsequent

rendering commands are discarded. If <em class="parameter"><code>mode</code></em> is <code class="constant">GL_QUERY_NO_WAIT</code>, the GL may choose to unconditionally

execute the subsequent rendering commands without waiting for the query to complete.

</p>

<p>

If <em class="parameter"><code>mode</code></em> is <code class="constant">GL_QUERY_BY_REGION_WAIT</code>, the GL will also wait for occlusion query results and discard

rendering commands if the result of the occlusion query is zero. If the query result is non-zero, subsequent rendering commands are executed,

but the GL may discard the results of the commands for any region of the framebuffer that did not contribute to the sample count in the specified

occlusion query. Any such discarding is done in an implementation-dependent manner, but the rendering command results may not be discarded for

any samples that contributed to the occlusion query sample count. If <em class="parameter"><code>mode</code></em> is <code class="constant">GL_QUERY_BY_REGION_NO_WAIT</code>,

the GL operates as in <code class="constant">GL_QUERY_BY_REGION_WAIT</code>, but may choose to unconditionally execute the subsequent rendering commands

without waiting for the query to complete.

</p>

</div>

<div class="refsect1" id="notes">

<h2>Notes</h2>

<p>

<code class="function">glBeginConditionalRender</code> and <code class="function">glEndConditionalRender</code> are available only if the GL version is 3.0 or greater.

</p>

<p>

The <code class="constant">GL_ANY_SAMPLES_PASSED</code> query result is available only if the GL version is 3.3 or greater.

</p>

</div>

<div class="refsect1" id="errors">

<h2>Errors</h2>

<p>

<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>id</code></em> is not the name of an existing query object.

</p>

<p>

<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>mode</code></em> is not one of the accepted tokens.

</p>

<p>

<code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glBeginConditionalRender</code> is called while conditional rendering is active,

or if <code class="function">glEndConditionalRender</code> is called while conditional rendering is inactive.

</p>

<p>

<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>id</code></em> is the name of a query object with a target other than

<code class="constant">GL_SAMPLES_PASSED</code> or <code class="constant">GL_ANY_SAMPLES_PASSED</code>.

</p>

<p>

<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>id</code></em> is the name of a query currently in progress.

</p>

</div>

{$pipelinestall}{$examples}

<div class="refsect1" id="versions">

<h2>Version Support</h2>

<div class="informaltable">

<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">

<colgroup>

<col style="text-align: left; "/>

<col style="text-align: center; " class="firstvers"/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; " class="lastvers"/>

</colgroup>

<thead>

<tr>

<th style="text-align: left; border-right: 2px solid ; ">

</th>

<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">

<span class="bold"><strong>OpenGL Version</strong></span>

</th>

</tr>

<tr>

<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>Function / Feature Name</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>2.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>2.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.2</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.3</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.2</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.3</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.4</strong></span>

</th>

<th style="text-align: center; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.5</strong></span>

</th>

</tr>

</thead>

<tbody>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="function">glBeginConditionalRender</code>

</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-bottom: 2px solid ; ">✔</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; ">

<code class="function">glEndConditionalRender</code>

</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; ">✔</td>

</tr>

</tbody>

</table>

</div>

</div>

<div class="refsect1" id="seealso">

<h2>See Also</h2>

<p>

<a class="citerefentry" href="glGenQueries"><span class="citerefentry"><span class="refentrytitle">glGenQueries</span></span></a>,

<a class="citerefentry" href="glDeleteQueries"><span class="citerefentry"><span class="refentrytitle">glDeleteQueries</span></span></a>,

<a class="citerefentry" href="glBeginQuery"><span class="citerefentry"><span class="refentrytitle">glBeginQuery</span></span></a>

</p>

</div>

<div class="refsect1" id="Copyright">

<h2>Copyright</h2>

<p>

Copyright © 2010-2014 Khronos Group.

This material may be distributed subject to the terms and conditions set forth in

the Open Publication License, v 1.0, 8 June 1999.

<a class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.

</p>

</div>

</div>