Opentk/Source/Bind/Specifications/Docs/ES31/glGetRenderbufferParameteriv.xml

<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glGetRenderbufferParameteriv">
    <info>
        <copyright>
            <year>2010-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>glGetRenderbufferParameteriv</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glGetRenderbufferParameteriv</refname>
        <refpurpose>retrieve information about a bound renderbuffer object</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glGetRenderbufferParameteriv</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLenum <parameter>pname</parameter></paramdef>
                <paramdef>GLint *<parameter>params</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>target</parameter></term>
            <listitem>
                <para>
                    Specifies the target of the query operation. <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>pname</parameter></term>
            <listitem>
                <para>
                    Specifies the parameter whose value to retrieve from the renderbuffer bound to <parameter>target</parameter>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>params</parameter></term>
            <listitem>
                <para>
                    Specifies the address of an array to receive the value of the queried parameter.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>glGetRenderbufferParameteriv</function> retrieves information about a bound renderbuffer object. <parameter>target</parameter>
            specifies the target of the query operation and must be <constant>GL_RENDERBUFFER</constant>. <parameter>pname</parameter> specifies
            the parameter whose value to query and must be one of <constant>GL_RENDERBUFFER_WIDTH</constant>, <constant>GL_RENDERBUFFER_HEIGHT</constant>,
            <constant>GL_RENDERBUFFER_INTERNAL_FORMAT</constant>, <constant>GL_RENDERBUFFER_RED_SIZE</constant>, <constant>GL_RENDERBUFFER_GREEN_SIZE</constant>,
            <constant>GL_RENDERBUFFER_BLUE_SIZE</constant>, <constant>GL_RENDERBUFFER_ALPHA_SIZE</constant>, <constant>GL_RENDERBUFFER_DEPTH_SIZE</constant>,
            <constant>GL_RENDERBUFFER_STENCIL_SIZE</constant>, or <constant>GL_RENDERBUFFER_SAMPLES</constant>.
        </para>
        <para>
            Upon a successful return from <function>glGetRenderbufferParameteriv</function>, if <parameter>pname</parameter> is <constant>GL_RENDERBUFFER_WIDTH</constant>,
            <constant>GL_RENDERBUFFER_HEIGHT</constant>, <constant>GL_RENDERBUFFER_INTERNAL_FORMAT</constant>, or <constant>GL_RENDERBUFFER_SAMPLES</constant>,
            then <parameter>params</parameter> will contain the width in pixels, the height in pixels, the internal format, or the number of samples, respectively,
            of the image of the renderbuffer currently bound to <parameter>target</parameter>.
        </para>
        <para>
            If <parameter>pname</parameter> is <constant>GL_RENDERBUFFER_RED_SIZE</constant>, <constant>GL_RENDERBUFFER_GREEN_SIZE</constant>,
            <constant>GL_RENDERBUFFER_BLUE_SIZE</constant>, <constant>GL_RENDERBUFFER_ALPHA_SIZE</constant>, <constant>GL_RENDERBUFFER_DEPTH_SIZE</constant>,
            or <constant>GL_RENDERBUFFER_STENCIL_SIZE</constant>, then <parameter>params</parameter> will contain the actual resolutions (not the resolutions
            specified when the image array was defined) for the red, green, blue, alpha depth, or stencil components, respectively, of the image of the
            renderbuffer currently bound to <parameter>target</parameter>.
        </para>
    </refsect1>
    <refsect1 xml:id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one of the accepted tokens.
        </para>
    </refsect1>
    <refsect1 xml:id="versions">
        <title>API Version Support</title>
        <informaltable>
            <tgroup cols="4" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry>glGetRenderbufferParameteriv</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='es20']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glRenderbufferStorageMultisample</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2010-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.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>