Opentk/Source/Bind/Specifications/Docs/ES20/glRenderbufferStorage.xml
2014-03-28 20:06:55 +01:00

112 lines
5 KiB
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="glRenderbufferStorage">
<refmeta>
<refentrytitle>glRenderbufferStorage</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glRenderbufferStorage</refname>
<refpurpose>create and initialize a renderbuffer object's data store</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glRenderbufferStorage</function></funcdef>
<paramdef>GLenum <parameter>target</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 the renderbuffer target. The symbolic constant must be
<constant>GL_RENDERBUFFER</constant>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>internalformat</parameter></term>
<listitem>
<para>Specifies the color-renderable, depth-renderable, or
stencil-renderable format of the renderbuffer. Must be one of the
following symbolic constants:
<constant>GL_RGBA4</constant>,
<constant>GL_RGB565</constant>,
<constant>GL_RGB5_A1</constant>,
<constant>GL_DEPTH_COMPONENT16</constant>, or
<constant>GL_STENCIL_INDEX8</constant>.</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>glRenderbufferStorage</function> establishes the data
storage, format, and dimensions of a renderbuffer object's image. Any
existing data store for the renderbuffer is deleted and the contents
of the new data store are undefined.</para>
<para>An implementation may vary its allocation of internal component
resolution based on any <function>glRenderbufferStorage</function> parameter
(except <parameter>target</parameter>), but the allocation and chosen
internal format must not be a function of any other state and cannot be
changed once they are established. The actual resolution in bits of each
component of the allocated image can be queried with
<citerefentry><refentrytitle>glGetRenderbufferParameteriv</refentrytitle></citerefentry>.</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_ENUM</constant> is generated if
<parameter>internalformat</parameter> is not an accepted format.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>width</parameter> or <parameter>height</parameter> is less than zero
or greater than <constant>GL_MAX_RENDERBUFFER_SIZE</constant>.</para>
<para><constant>GL_OUT_OF_MEMORY</constant> is generated if the implementation is
unable to create a data store with the requested
<parameter>width</parameter> and <parameter>height</parameter>.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated if the reserved
renderbuffer object name 0 is bound.</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para><citerefentry><refentrytitle>glGetRenderbufferParameteriv</refentrytitle></citerefentry></para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para><citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGetRenderbufferParameteriv</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glIsRenderbuffer</refentrytitle></citerefentry></para>
</refsect1>
<refsect1 id="copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2008 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>