upstream-man-pages/man4/glIsRenderbuffer.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="glIsRenderbuffer">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glIsRenderbuffer</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glIsRenderbuffer</refname>
  17         <refpurpose>determine if a name corresponds to a renderbuffer object</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>GLboolean <function>glIsRenderbuffer</function></funcdef>
  23                 <paramdef>GLuint <parameter>renderbuffer</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>renderbuffer</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies a value that may be the name of a renderbuffer object.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>glIsRenderbuffer</function> returns <constant>GL_TRUE</constant> if <parameter>renderbuffer</parameter> is currently the name of a renderbuffer
  42             object. If <parameter>renderbuffer</parameter> is zero, or if <parameter>renderbuffer</parameter> is not the name of a renderbuffer object, or if an error
  43             occurs, <function>glIsRenderbuffer</function> returns <constant>GL_FALSE</constant>. If <parameter>renderbuffer</parameter> is a name returned by
  44             <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>, by that has not yet been bound through a call to
  45             <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry> or <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
  46             then the name is not a renderbuffer object and <function>glIsRenderbuffer</function> returns <constant>GL_FALSE</constant>.
  47         </para>
  48     </refsect1>
  49     <refsect1 id="seealso"><title>See Also</title>
  50         <para>
  51             <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
  52             <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,
  53             <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
  54             <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>
  55         </para>
  56     </refsect1>
  57     <refsect1 id="Copyright"><title>Copyright</title>
  58         <para>
  59             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  60             This material may be distributed subject to the terms and conditions set forth in
  61             the Open Publication License, v 1.0, 8 June 1999.
  62             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  63         </para>
  64     </refsect1>
  65 </refentry>