upstream-doc/man4/glFramebufferParameteri.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glFramebufferParameteri">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glFramebufferParameteri</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glFramebufferParameteri</refname>
  17         <refpurpose>set a named parameter of a framebuffer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glFramebufferParameteri</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLenum <parameter>pname</parameter></paramdef>
  25                 <paramdef>GLint <parameter>param</parameter></paramdef>
  26             </funcprototype>
  27         </funcsynopsis>
  28     </refsynopsisdiv>
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>target</parameter></term>
  33             <listitem>
  34                 <para>
  35                     The target of the operation, which must be <constant>GL_READ_FRAMEBUFFER</constant>,
  36                     <constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>.
  37                 </para>
  38             </listitem>
  39         </varlistentry>
  40         <varlistentry>
  41             <term><parameter>pname</parameter></term>
  42             <listitem>
  43                 <para>
  44                     A token indicating the parameter to be modified.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>param</parameter></term>
  50             <listitem>
  51                 <para>
  52                     The new value for the parameter named <parameter>pname</parameter>.
  53                 </para>
  54             </listitem>
  55         </varlistentry>
  56         </variablelist>
  57     </refsect1>
  58     <refsect1 id="description"><title>Description</title>
  59         <para>
  60             <function>glFramebufferParameteri</function> modifies the current value of the parameter
  61             named <parameter>pname</parameter> in the framebuffer bound to <parameter>target</parameter>.
  62             <parameter>target</parameter> must be <constant>GL_READ_FRAMEBFUFFER</constant>,
  63             <constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>. The
  64             token <constant>GL_FRAMEBUFFER</constant> is treated as <constant>GL_DRAW_FRAMEBUFFER</constant>.
  65             A non-default framebuffer must be bound to <parameter>target</parameter>.
  66         </para>
  67         <para>
  68             <parameter>pname</parameter> specifies the parameter to be modified. The following symbols
  69             are accepted in <parameter>pname</parameter>:
  70         </para>
  71         <variablelist>
  72             <varlistentry>
  73                 <term><constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant></term>
  74                 <listitem>
  75                     <para>
  76                         <parameter>param</parameter> specifies the assumed with for a framebuffer object with no attachments. If a
  77                         framebuffer has attachments then the width of those attachments is used, otherwise
  78                         the value of <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant> is used for the
  79                         framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than
  80                         or equal to the value of <constant>GL_MAX_FRAMEBUFFER_WIDTH</constant>.
  81                     </para>
  82                 </listitem>
  83             </varlistentry>
  84             <varlistentry>
  85                 <term><constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant></term>
  86                 <listitem>
  87                     <para>
  88                         <parameter>param</parameter> specifies the assumed height for a framebuffer object with no attachments. If a
  89                         framebuffer has attachments then the height of those attachments is used, otherwise
  90                         the value of <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant> is used for the
  91                         framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than
  92                         or equal to the value of <constant>GL_MAX_FRAMEBUFFER_HEIGHT</constant>.
  93                     </para>
  94                 </listitem>
  95             </varlistentry>
  96             <varlistentry>
  97                 <term><constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant></term>
  98                 <listitem>
  99                     <para>
 100                         <parameter>param</parameter> specifies the assumed number of layers for a framebuffer object with no attachments. If a
 101                         framebuffer has attachments then the layer count of those attachments is used, otherwise
 102                         the value of <constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant> is used for the
 103                         framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than
 104                         or equal to the value of <constant>GL_MAX_FRAMEBUFFER_LAYERS</constant>.
 105                     </para>
 106                 </listitem>
 107             </varlistentry>
 108             <varlistentry>
 109                 <term><constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant></term>
 110                 <listitem>
 111                     <para>
 112                         <parameter>param</parameter> specifies the assumed number of samples in a framebuffer object with no attachments. If a
 113                         framebuffer has attachments then the sample count of those attachments is used, otherwise
 114                         the value of <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant> is used for the
 115                         framebuffer. <parameter>param</parameter> must be greater than or equal to zero and less than
 116                         or equal to the value of <constant>GL_MAX_FRAMEBUFFER_SAMPLE</constant>.
 117                     </para>
 118                 </listitem>
 119             </varlistentry>
 120             <varlistentry>
 121                 <term><constant>GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</constant></term>
 122                 <listitem>
 123                     <para>
 124                         <parameter>param</parameter> specifies whether the framebuffer should assume identical sample locations and
 125                         the same number of samples for all texels in the virtual image. If <parameter>param</parameter> is zero,
 126                         then the implementation may vary the position or the count of samples within the virtual image from
 127                         pixel to pixel, otherwise it will use the same sample position and count for all pixels in the virtual image.
 128                     </para>
 129                 </listitem>
 130             </varlistentry>
 131         </variablelist>
 132     </refsect1>
 133     <refsect1 id="errors"><title>Errors</title>
 134         <para>
 135             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the accepted
 136             framebuffer targets.
 137         </para>
 138         <para>
 139             <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_WIDTH</constant>
 140             and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_WIDTH</constant>.
 141         </para>
 142         <para>
 143             <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_HEIGHT</constant>
 144             and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_HEIGHT</constant>.
 145         </para>
 146         <para>
 147             <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_LAYERS</constant>
 148             and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_LAYERS</constant>.
 149         </para>
 150         <para>
 151             <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>pname</parameter> is <constant>GL_FRAMEBUFFER_DEFAULT_SAMPLES</constant>
 152             and <parameter>param</parameter> is less than zero or greater than the value of <constant>GL_MAX_FRAMEBUFFER_SAMPLES</constant>.
 153         </para>
 154         <para>
 155             <constant>GL_INVALID_OPERATION</constant> is generated if the default framebuffer is bound to <parameter>target</parameter>.
 156         </para>
 157     </refsect1>
 158     <refsect1 id="associatedgets"><title>Associated Gets</title>
 159         <para>
 160             <citerefentry><refentrytitle>glGetFramebufferParameteriv</refentrytitle></citerefentry>.
 161         </para>
 162     </refsect1>
 163     <refsect1 id="seealso"><title>See Also</title>
 164         <para>
 165             <citerefentry><refentrytitle>glVertexAttribBinding</refentrytitle></citerefentry>,
 166             <citerefentry><refentrytitle>glVertexAttribFormat</refentrytitle></citerefentry>,
 167             <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,
 168             <citerefentry><refentrytitle>glVertexBindingDivisor</refentrytitle></citerefentry>.
 169         </para>
 170     </refsect1>
 171     <refsect1 id="Copyright"><title>Copyright</title>
 172         <para>
 173             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
 174             This material may be distributed subject to the terms and conditions set forth in
 175             the Open Publication License, v 1.0, 8 June 1999.
 176             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 177         </para>
 178     </refsect1>
 179 </refentry>