upstream-doc/man2/glGenTextures.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="glGenTextures">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGenTextures</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGenTextures</refname>
  17         <refpurpose>generate texture names</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glGenTextures</function></funcdef>
  23                 <paramdef>GLsizei <parameter>n</parameter></paramdef>
  24                 <paramdef>GLuint * <parameter>textures</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>n</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies the number of texture names to be generated.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>textures</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies an array in which the generated texture names are stored.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glGenTextures</function> returns <parameter>n</parameter> texture names in <parameter>textures</parameter>.
  51             There is no guarantee that the names form a contiguous set of integers;
  52             however, it is guaranteed that none of the returned names was in use
  53             immediately before the call to <function>glGenTextures</function>.
  54         </para>
  55         <para>
  56             The generated textures have no dimensionality; they assume the dimensionality
  57             of the texture target to which they are first bound
  58             (see <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>).
  59         </para>
  60         <para>
  61             Texture names returned by a call to <function>glGenTextures</function> are not returned by
  62             subsequent calls, unless they are first deleted with
  63             <citerefentry><refentrytitle>glDeleteTextures</refentrytitle></citerefentry>.
  64         </para>
  65     </refsect1>
  66     <refsect1 id="notes"><title>Notes</title>
  67         <para>
  68             <function>glGenTextures</function> is available only if the GL version is 1.1 or greater.
  69         </para>
  70     </refsect1>
  71     <refsect1 id="errors"><title>Errors</title>
  72         <para>
  73             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
  74         </para>
  75         <para>
  76             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glGenTextures</function> is executed
  77             between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
  78             execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
  79         </para>
  80     </refsect1>
  81     <refsect1 id="associatedgets"><title>Associated Gets</title>
  82         <para>
  83             <citerefentry><refentrytitle>glIsTexture</refentrytitle></citerefentry>
  84         </para>
  85     </refsect1>
  86     <refsect1 id="seealso"><title>See Also</title>
  87         <para>
  88             <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>,
  89             <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
  90             <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
  91             <citerefentry><refentrytitle>glDeleteTextures</refentrytitle></citerefentry>,
  92             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>,
  93             <citerefentry><refentrytitle>glGetTexParameter</refentrytitle></citerefentry>,
  94             <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
  95             <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
  96             <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
  97             <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
  98         </para>
  99     </refsect1>
 100     <refsect1 id="Copyright"><title>Copyright</title>
 101         <para>
 102             Copyright <trademark class="copyright"></trademark> 1991-2006
 103             Silicon Graphics, Inc. This document is licensed under the SGI
 104             Free Software B License. For details, see
 105             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 106         </para>
 107     </refsect1>
 108 </refentry>