HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
| 3 | <!-- saved from url=(0013)about:internet --> | |
| 4 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glFramebufferParameteri - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glFramebufferParameteri"></a><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 border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glFramebufferParameteri</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">param</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p> | |
| 5 | The target of the operation, which must be <code class="constant">GL_READ_FRAMEBUFFER</code>, | |
| 6 | <code class="constant">GL_DRAW_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>. | |
| 7 | </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p> | |
| 8 | A token indicating the parameter to be modified. | |
| 9 | </p></dd><dt><span class="term"><em class="parameter"><code>param</code></em></span></dt><dd><p> | |
| 10 | The new value for the parameter named <em class="parameter"><code>pname</code></em>. | |
| 11 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
| 12 | <code class="function">glFramebufferParameteri</code> modifies the current value of the parameter | |
| 13 | named <em class="parameter"><code>pname</code></em> in the framebuffer bound to <em class="parameter"><code>target</code></em>. | |
| 14 | <em class="parameter"><code>target</code></em> must be <code class="constant">GL_READ_FRAMEBFUFFER</code>, | |
| 15 | <code class="constant">GL_DRAW_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>. The | |
| 16 | token <code class="constant">GL_FRAMEBUFFER</code> is treated as <code class="constant">GL_DRAW_FRAMEBUFFER</code>. | |
| 17 | A non-default framebuffer must be bound to <em class="parameter"><code>target</code></em>. | |
| 18 | </p><p> | |
| 19 | <em class="parameter"><code>pname</code></em> specifies the parameter to be modified. The following symbols | |
| 20 | are accepted in <em class="parameter"><code>pname</code></em>: | |
| 21 | </p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code></span></dt><dd><p> | |
| 22 | <em class="parameter"><code>param</code></em> specifies the assumed with for a framebuffer object with no attachments. If a | |
| 23 | framebuffer has attachments then the width of those attachments is used, otherwise | |
| 24 | the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code> is used for the | |
| 25 | framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than | |
| 26 | or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_WIDTH</code>. | |
| 27 | </p></dd><dt><span class="term"><code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code></span></dt><dd><p> | |
| 28 | <em class="parameter"><code>param</code></em> specifies the assumed height for a framebuffer object with no attachments. If a | |
| 29 | framebuffer has attachments then the height of those attachments is used, otherwise | |
| 30 | the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code> is used for the | |
| 31 | framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than | |
| 32 | or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_HEIGHT</code>. | |
| 33 | </p></dd><dt><span class="term"><code class="constant">GL_FRAMEBUFFER_DEFAULT_LAYERS</code></span></dt><dd><p> | |
| 34 | <em class="parameter"><code>param</code></em> specifies the assumed number of layers for a framebuffer object with no attachments. If a | |
| 35 | framebuffer has attachments then the layer count of those attachments is used, otherwise | |
| 36 | the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_LAYERS</code> is used for the | |
| 37 | framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than | |
| 38 | or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_LAYERS</code>. | |
| 39 | </p></dd><dt><span class="term"><code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code></span></dt><dd><p> | |
| 40 | <em class="parameter"><code>param</code></em> specifies the assumed number of samples in a framebuffer object with no attachments. If a | |
| 41 | framebuffer has attachments then the sample count of those attachments is used, otherwise | |
| 42 | the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code> is used for the | |
| 43 | framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than | |
| 44 | or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_SAMPLE</code>. | |
| 45 | </p></dd><dt><span class="term"><code class="constant">GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</code></span></dt><dd><p> | |
| 46 | <em class="parameter"><code>param</code></em> specifies whether the framebuffer should assume identical sample locations and | |
| 47 | the same number of samples for all texels in the virtual image. If <em class="parameter"><code>param</code></em> is zero, | |
| 48 | then the implementation may vary the position or the count of samples within the virtual image from | |
| 49 | pixel to pixel, otherwise it will use the same sample position and count for all pixels in the virtual image. | |
| 50 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
| 51 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the accepted | |
| 52 | framebuffer targets. | |
| 53 | </p><p> | |
| 54 | <code class="constant">GL_INVAILD_VALUE</code> is generated if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code> | |
| 55 | 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>. | |
| 56 | </p><p> | |
| 57 | <code class="constant">GL_INVAILD_VALUE</code> is generated if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code> | |
| 58 | 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>. | |
| 59 | </p><p> | |
| 60 | <code class="constant">GL_INVAILD_VALUE</code> is generated if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_FRAMEBUFFER_DEFAULT_LAYERS</code> | |
| 61 | and <em class="parameter"><code>param</code></em> is less than zero or greater than the value of <code class="constant">GL_MAX_FRAMEBUFFER_LAYERS</code>. | |
| 62 | </p><p> | |
| 63 | <code class="constant">GL_INVAILD_VALUE</code> is generated if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code> | |
| 64 | 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>. | |
| 65 | </p><p> | |
| 66 | <code class="constant">GL_INVALID_OPERATION</code> is generated if the default framebuffer is bound to <em class="parameter"><code>target</code></em>. | |
| 67 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
| 68 | <a href="glGetFramebufferParameteriv.xml"><span class="citerefentry"><span class="refentrytitle">glGetFramebufferParameteriv</span></span></a>. | |
| 69 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
| 70 | <a href="glVertexAttribBinding.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribBinding</span></span></a>, | |
| 71 | <a href="glVertexAttribFormat.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribFormat</span></span></a>, | |
| 72 | <a href="glVertexAttribPointer.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>, | |
| 73 | <a href="glVertexBindingDivisor.xml"><span class="citerefentry"><span class="refentrytitle">glVertexBindingDivisor</span></span></a>. | |
| 74 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 75 | Copyright <span class="trademark"></span>© 2012 Khronos Group. | |
| 76 | This material may be distributed subject to the terms and conditions set forth in | |
| 77 | the Open Publication License, v 1.0, 8 June 1999. | |
| 78 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 79 | </p></div></div></body></html> |