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

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

<div class="refnamediv">

<h2>Name</h2>

<p>glFramebufferParameteri — set a named parameter of a framebuffer</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">glFramebufferParameteri</strong>(</code>

</td>

<td>GLenum <var class="pdparam">target</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLenum <var class="pdparam">pname</var>, </td>

</tr>

<tr>

<td> </td>

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

</tr>

</table>

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

</div>

</div>

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

<h2>Parameters</h2>

<div class="variablelist">

<dl class="variablelist">

<dt>

<span class="term">

<em class="parameter">

<code>target</code>

</em>

</span>

</dt>

<dd>

<p>

The target of the operation, which must be <code class="constant">GL_READ_FRAMEBUFFER</code>,

<code class="constant">GL_DRAW_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>.

</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>pname</code>

</em>

</span>

</dt>

<dd>

<p>

A token indicating the parameter to be modified.

</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>param</code>

</em>

</span>

</dt>

<dd>

<p>

The new value for the parameter named <em class="parameter"><code>pname</code></em>.

</p>

</dd>

</dl>

</div>

</div>

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

<h2>Description</h2>

<p>

<code class="function">glFramebufferParameteri</code> modifies the current value of the parameter

named <em class="parameter"><code>pname</code></em> in the framebuffer bound to <em class="parameter"><code>target</code></em>.

<em class="parameter"><code>target</code></em> must be <code class="constant">GL_READ_FRAMEBFUFFER</code>,

<code class="constant">GL_DRAW_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>. The

token <code class="constant">GL_FRAMEBUFFER</code> is treated as <code class="constant">GL_DRAW_FRAMEBUFFER</code>.

A non-default framebuffer must be bound to <em class="parameter"><code>target</code></em>.

</p>

<p>

<em class="parameter"><code>pname</code></em> specifies the parameter to be modified. The following symbols

are accepted in <em class="parameter"><code>pname</code></em>:

</p>

<div class="variablelist">

<dl class="variablelist">

<dt>

<span class="term">

<code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code>

</span>

</dt>

<dd>

<p>

<em class="parameter"><code>param</code></em> specifies the assumed with for a framebuffer object with no attachments. If a

framebuffer has attachments then the width of those attachments is used, otherwise

the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code> is used for the

framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than

or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_WIDTH</code>.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code>

</span>

</dt>

<dd>

<p>

<em class="parameter"><code>param</code></em> specifies the assumed height for a framebuffer object with no attachments. If a

framebuffer has attachments then the height of those attachments is used, otherwise

the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code> is used for the

framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than

or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_HEIGHT</code>.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code>

</span>

</dt>

<dd>

<p>

<em class="parameter"><code>param</code></em> specifies the assumed number of samples in a framebuffer object with no attachments. If a

framebuffer has attachments then the sample count of those attachments is used, otherwise

the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code> is used for the

framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than

or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_SAMPLE</code>.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</code>

</span>

</dt>

<dd>

<p>

<em class="parameter"><code>param</code></em> specifies whether the framebuffer should assume identical sample locations and

the same number of samples for all texels in the virtual image. If <em class="parameter"><code>param</code></em> is zero,

then the implementation may vary the position or the count of samples within the virtual image from

pixel to pixel, otherwise it will use the same sample position and count for all pixels in the virtual image.

</p>

</dd>

</dl>

</div>

</div>

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

<h2>Errors</h2>

<p>

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

framebuffer targets.

</p>

<p>

<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code>

and <em class="parameter"><code>param</code></em> is less than zero or greater than the value of <code class="constant">GL_MAX_FRAMEBUFFER_WIDTH</code>.

</p>

<p>

<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code>

and <em class="parameter"><code>param</code></em> is less than zero or greater than the value of <code class="constant">GL_MAX_FRAMEBUFFER_HEIGHT</code>.

</p>

<p>

<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code>

and <em class="parameter"><code>param</code></em> is less than zero or greater than the value of <code class="constant">GL_MAX_FRAMEBUFFER_SAMPLES</code>.

</p>

<p>

<code class="constant">GL_INVALID_OPERATION</code> is generated if the default framebuffer is bound to <em class="parameter"><code>target</code></em>.

</p>

</div>

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

<h2>Associated Gets</h2>

<p>

<a class="citerefentry" href="glGetFramebufferParameteriv"><span class="citerefentry"><span class="refentrytitle">glGetFramebufferParameteriv</span></span></a>.

</p>

</div>

{$pipelinestall}{$examples}

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

<h2>API 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; " 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="3">

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

</th>

</tr>

<tr>

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

<span class="bold"><strong>Function 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>3.0</strong></span>

</th>

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

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

</th>

</tr>

</thead>

<tbody>

<tr>

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

<code class="function">glFramebufferParameteri</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; ">✔</td>

</tr>

</tbody>

</table>

</div>

</div>

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

<h2>See Also</h2>

<p>

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

</p>

</div>

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

<h2>Copyright</h2>

<p>

Copyright © 2012-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>