upstream-man-pages/man3/glBindRenderbuffer.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="glBindRenderbuffer">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glBindRenderbuffer</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glBindRenderbuffer</refname>
  17         <refpurpose>bind a renderbuffer to a renderbuffer target</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glBindRenderbuffer</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLuint <parameter>renderbuffer</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>target</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies the renderbuffer target of the binding operation. <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>renderbuffer</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies the name of the renderbuffer object to bind.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glBindRenderbuffer</function> binds the renderbuffer object with name <parameter>renderbuffer</parameter> to the renderbuffer target specified
  51             by <parameter>target</parameter>. <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>. <parameter>renderbuffer</parameter>
  52             is the name of a renderbuffer object previously returned from a call to <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
  53             or zero to break the existing binding of a renderbuffer object to <parameter>target</parameter>.
  54         </para>
  55     </refsect1>
  56     <refsect1 id="errors"><title>Errors</title>
  57         <para>
  58             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_RENDERBUFFER</constant>.
  59         </para>
  60         <para>
  61             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>renderbuffer</parameter> is not zero or the name of a renderbuffer
  62             previously returned from a call to <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>.
  63         </para>
  64     </refsect1>
  65     <refsect1 id="seealso"><title>See Also</title>
  66         <para>
  67             <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>,
  69             <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,
  70             <citerefentry><refentrytitle>glRenderbufferStorageMultisample</refentrytitle></citerefentry>,
  71             <citerefentry><refentrytitle>glIsRenderbuffer</refentrytitle></citerefentry>
  72         </para>
  73     </refsect1>
  74     <refsect1 id="Copyright"><title>Copyright</title>
  75         <para>
  76             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  77             This material may be distributed subject to the terms and conditions set forth in
  78             the Open Publication License, v 1.0, 8 June 1999.
  79             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  80         </para>
  81     </refsect1>
  82 </refentry>