57bee58d17a9da9c5694c54a00c9b4266421d634
[clinton/guile-figl.git] / upstream-man-pages / man2 / glDeleteTextures.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="glDeleteTextures">
5 <refmeta>
6 <refmetainfo>
7 <copyright>
8 <year>1991-2006</year>
9 <holder>Silicon Graphics, Inc.</holder>
10 </copyright>
11 </refmetainfo>
12 <refentrytitle>glDeleteTextures</refentrytitle>
13 <manvolnum>3G</manvolnum>
14 </refmeta>
15 <refnamediv>
16 <refname>glDeleteTextures</refname>
17 <refpurpose>delete named textures</refpurpose>
18 </refnamediv>
19 <refsynopsisdiv><title>C Specification</title>
20 <funcsynopsis>
21 <funcprototype>
22 <funcdef>void <function>glDeleteTextures</function></funcdef>
23 <paramdef>GLsizei <parameter>n</parameter></paramdef>
24 <paramdef>const 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 textures to be deleted.
35 </para>
36 </listitem>
37 </varlistentry>
38 <varlistentry>
39 <term><parameter>textures</parameter></term>
40 <listitem>
41 <para>
42 Specifies an array of textures to be deleted.
43 </para>
44 </listitem>
45 </varlistentry>
46 </variablelist>
47 </refsect1>
48 <refsect1 id="description"><title>Description</title>
49 <para>
50 <function>glDeleteTextures</function> deletes <parameter>n</parameter> textures named by the elements of the array <parameter>textures</parameter>.
51 After a texture is deleted, it has no contents or dimensionality,
52 and its name is free for reuse (for example by <citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>).
53 If a texture that is currently bound is deleted, the binding reverts
54 to 0 (the default texture).
55 </para>
56 <para>
57 <function>glDeleteTextures</function> silently ignores 0's and names that do not correspond to
58 existing textures.
59 </para>
60 </refsect1>
61 <refsect1 id="notes"><title>Notes</title>
62 <para>
63 <function>glDeleteTextures</function> is available only if the GL version is 1.1 or greater.
64 </para>
65 </refsect1>
66 <refsect1 id="errors"><title>Errors</title>
67 <para>
68 <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
69 </para>
70 <para>
71 <constant>GL_INVALID_OPERATION</constant> is generated if <function>glDeleteTextures</function> is executed
72 between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
73 execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
74 </para>
75 </refsect1>
76 <refsect1 id="associatedgets"><title>Associated Gets</title>
77 <para>
78 <citerefentry><refentrytitle>glIsTexture</refentrytitle></citerefentry>
79 </para>
80 </refsect1>
81 <refsect1 id="seealso"><title>See Also</title>
82 <para>
83 <citerefentry><refentrytitle>glAreTexturesResident</refentrytitle></citerefentry>,
84 <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>,
85 <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
86 <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
87 <citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>,
88 <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>,
89 <citerefentry><refentrytitle>glGetTexParameter</refentrytitle></citerefentry>,
90 <citerefentry><refentrytitle>glPrioritizeTextures</refentrytitle></citerefentry>,
91 <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
92 <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
93 <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
94 </para>
95 </refsect1>
96 <refsect1 id="Copyright"><title>Copyright</title>
97 <para>
98 Copyright <trademark class="copyright"></trademark> 1991-2006
99 Silicon Graphics, Inc. This document is licensed under the SGI
100 Free Software B License. For details, see
101 <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
102 </para>
103 </refsect1>
104 </refentry>