upstream-man-pages/man3/glIsTexture.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="glIsTexture">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glIsTexture</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glIsTexture</refname>
  17         <refpurpose>determine if a name corresponds to a texture</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>GLboolean <function>glIsTexture</function></funcdef>
  23                 <paramdef>GLuint <parameter>texture</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>texture</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies a value that may be the name of a texture.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>glIsTexture</function> returns <constant>GL_TRUE</constant> if <parameter>texture</parameter> is currently the name of a texture.
  42             If <parameter>texture</parameter> is zero, or is a non-zero value that is not currently the
  43             name of a texture, or if an error occurs, <function>glIsTexture</function> returns <constant>GL_FALSE</constant>.
  44         </para>
  45         <para>
  46             A name returned by <citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>, but not yet associated with a texture
  47             by calling <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>, is not the name of a texture.
  48         </para>
  49     </refsect1>
  50     <refsect1 id="seealso"><title>See Also</title>
  51         <para>
  52             <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>,
  53             <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
  54             <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
  55             <citerefentry><refentrytitle>glDeleteTextures</refentrytitle></citerefentry>,
  56             <citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>,
  57             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>,
  58             <citerefentry><refentrytitle>glGetTexParameter</refentrytitle></citerefentry>,
  59             <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
  60             <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
  61             <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
  62             <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
  63         </para>
  64     </refsect1>
  65     <refsect1 id="Copyright"><title>Copyright</title>
  66         <para>
  67             Copyright <trademark class="copyright"></trademark> 1991-2006
  68             Silicon Graphics, Inc. This document is licensed under the SGI
  69             Free Software B License. For details, see
  70             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  71         </para>
  72     </refsect1>
  73 </refentry>