upstream-doc/man4/glRenderbufferStorageMultisample.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="glRenderbufferStorageMultisample">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glRenderbufferStorageMultisample</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glRenderbufferStorageMultisample</refname>
  17         <refpurpose>establish data storage, format, dimensions and sample count of a renderbuffer object's image</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glRenderbufferStorageMultisample</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLsizei <parameter>samples</parameter></paramdef>
  25                 <paramdef>GLenum <parameter>internalformat</parameter></paramdef>
  26                 <paramdef>GLsizei <parameter>width</parameter></paramdef>
  27                 <paramdef>GLsizei <parameter>height</parameter></paramdef>
  28             </funcprototype>
  29         </funcsynopsis>
  30     </refsynopsisdiv>
  31     <refsect1 id="parameters"><title>Parameters</title>
  32         <variablelist>
  33         <varlistentry>
  34             <term><parameter>target</parameter></term>
  35             <listitem>
  36                 <para>
  37                     Specifies a binding to which the target of the allocation and must be <constant>GL_RENDERBUFFER</constant>.
  38                 </para>
  39             </listitem>
  40         </varlistentry>
  41         <varlistentry>
  42             <term><parameter>samples</parameter></term>
  43             <listitem>
  44                 <para>
  45                     Specifies the number of samples to be used for the renderbuffer object's storage.
  46                 </para>
  47             </listitem>
  48         </varlistentry>
  49         <varlistentry>
  50             <term><parameter>internalformat</parameter></term>
  51             <listitem>
  52                 <para>
  53                     Specifies the internal format to use for the renderbuffer object's image.
  54                 </para>
  55             </listitem>
  56         </varlistentry>
  57         <varlistentry>
  58             <term><parameter>width</parameter></term>
  59             <listitem>
  60                 <para>
  61                     Specifies the width of the renderbuffer, in pixels.
  62                 </para>
  63             </listitem>
  64         </varlistentry>
  65         <varlistentry>
  66             <term><parameter>height</parameter></term>
  67             <listitem>
  68                 <para>
  69                     Specifies the height of the renderbuffer, in pixels.
  70                 </para>
  71             </listitem>
  72         </varlistentry>
  73         </variablelist>
  74     </refsect1>
  75     <refsect1 id="description"><title>Description</title>
  76         <para>
  77             <function>glRenderbufferStorageMultisample</function> establishes the data storage, format, dimensions and number of
  78             samples of a renderbuffer object's image.
  79         </para>
  80         <para>
  81             The target of the operation, specified by <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.
  82             <parameter>internalformat</parameter> specifies the internal format to be used for the renderbuffer object's storage and
  83             must be a color-renderable, depth-renderable, or stencil-renderable format.
  84             <parameter>width</parameter> and <parameter>height</parameter> are the dimensions, in pixels, of the renderbuffer.
  85             Both <parameter>width</parameter> and <parameter>height</parameter> must be less than or equal to the value of
  86             <constant>GL_MAX_RENDERBUFFER_SIZE</constant>. <parameter>samples</parameter> specifies the number of samples to be used
  87             for the renderbuffer object's image, and must be less than or equal to the value of <constant>GL_MAX_SAMPLES</constant>.
  88             If <parameter>internalformat</parameter> is a signed or unsigned integer format then <parameter>samples</parameter> must be
  89             less than or equal to the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.
  90         </para>
  91         <para>
  92             Upon success, <function>glRenderbufferStorageMultisample</function> deletes any existing data store for the renderbuffer
  93             image and the contents of the data store after calling <function>glRenderbufferStorageMultisample</function> are undefined.
  94         </para>
  95     </refsect1>
  96     <refsect1 id="errors"><title>Errors</title>
  97         <para>
  98             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_RENDERBUFFER</constant>.
  99         </para>
 100         <para>
 101             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than <constant>GL_MAX_SAMPLES</constant>.
 102         </para>
 103         <para>
 104             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a color-renderable, depth-renderable,
 105             or stencil-renderable format.
 106         </para>
 107         <para>
 108             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a signed or unsigned integer format
 109             and <parameter>samples</parameter> is greater than the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>
 110         </para>
 111         <para>
 112             <constant>GL_INVALID_VALUE</constant> is generated if either of <parameter>width</parameter> or <parameter>height</parameter> is negative,
 113             or greater than the value of <constant>GL_MAX_RENDERBUFFER_SIZE</constant>.
 114         </para>
 115         <para>
 116             <constant>GL_OUT_OF_MEMORY</constant> is generated if the GL is unable to create a data store of the requested size.
 117         </para>
 118     </refsect1>
 119     <refsect1 id="seealso"><title>See Also</title>
 120         <para>
 121             <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
 122             <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,
 123             <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,
 124             <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
 125             <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>
 126         </para>
 127     </refsect1>
 128     <refsect1 id="Copyright"><title>Copyright</title>
 129         <para>
 130             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
 131             This material may be distributed subject to the terms and conditions set forth in
 132             the Open Publication License, v 1.0, 8 June 1999.
 133             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 134         </para>
 135     </refsect1>
 136 </refentry>