Opentk/Source/Bind/Specifications/Docs/glRenderbufferStorageMultisample.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glRenderbufferStorageMultisample">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>2010</year>
                <holder>Khronos Group</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glRenderbufferStorageMultisample</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glRenderbufferStorageMultisample</refname>
        <refpurpose>establish data storage, format, dimensions and sample count of a renderbuffer object's image</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glRenderbufferStorageMultisample</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLsizei <parameter>samples</parameter></paramdef>
                <paramdef>GLenum <parameter>internalformat</parameter></paramdef>
                <paramdef>GLsizei <parameter>width</parameter></paramdef>
                <paramdef>GLsizei <parameter>height</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>target</parameter></term>
            <listitem>
                <para>
                    Specifies a binding to which the target of the allocation and must be <constant>GL_RENDERBUFFER</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>samples</parameter></term>
            <listitem>
                <para>
                    Specifies the number of samples to be used for the renderbuffer object's storage.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>internalformat</parameter></term>
            <listitem>
                <para>
                    Specifies the internal format to use for the renderbuffer object's image.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>width</parameter></term>
            <listitem>
                <para>
                    Specifies the width of the renderbuffer, in pixels.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>height</parameter></term>
            <listitem>
                <para>
                    Specifies the height of the renderbuffer, in pixels.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glRenderbufferStorageMultisample</function> establishes the data storage, format, dimensions and number of
            samples of a renderbuffer object's image.
        </para>
        <para>
            The target of the operation, specified by <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.
            <parameter>internalformat</parameter> specifies the internal format to be used for the renderbuffer object's storage and
            must be a color-renderable, depth-renderable, or stencil-renderable format.
            <parameter>width</parameter> and <parameter>height</parameter> are the dimensions, in pixels, of the renderbuffer.
            Both <parameter>width</parameter> and <parameter>height</parameter> must be less than or equal to the value of
            <constant>GL_MAX_RENDERBUFFER_SIZE</constant>. <parameter>samples</parameter> specifies the number of samples to be used
            for the renderbuffer object's image, and must be less than or equal to the value of <constant>GL_MAX_SAMPLES</constant>.
            If <parameter>internalformat</parameter> is a signed or unsigned integer format then <parameter>samples</parameter> must be
            less than or equal to the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.
        </para>
        <para>
            Upon success, <function>glRenderbufferStorageMultisample</function> deletes any existing data store for the renderbuffer
            image and the contents of the data store after calling <function>glRenderbufferStorageMultisample</function> are undefined.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_RENDERBUFFER</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than <constant>GL_MAX_SAMPLES</constant>.
        </para>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a color-renderable, depth-renderable,
            or stencil-renderable format.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a signed or unsigned integer format
            and <parameter>samples</parameter> is greater than the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if either of <parameter>width</parameter> or <parameter>height</parameter> is negative,
            or greater than the value of <constant>GL_MAX_RENDERBUFFER_SIZE</constant>.
        </para>
        <para>
            <constant>GL_OUT_OF_MEMORY</constant> is generated if the GL is unable to create a data store of the requested size.
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2010 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.
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
        </para>
    </refsect1>
</refentry>