rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / glDeleteSamplers.xml
CommitLineData
7faf1d71
AW
1<?xml version="1.0" encoding="UTF-8"?>\r
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
4<refentry id="glDeleteSamplers">\r
5 <refmeta>\r
6 <refmetainfo>\r
7 <copyright>\r
8 <year>2010</year>\r
9 <holder>Khronos Group</holder>\r
10 </copyright>\r
11 </refmetainfo>\r
12 <refentrytitle>glDeleteSamplers</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>glDeleteSamplers</refname>\r
17 <refpurpose>delete named sampler objects</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>C Specification</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>void <function>glDeleteSamplers</function></funcdef>\r
23 <paramdef>GLsizei <parameter>n</parameter></paramdef>\r
24 <paramdef>const GLuint * <parameter>samplers</parameter></paramdef>\r
25 </funcprototype>\r
26 </funcsynopsis>\r
27 </refsynopsisdiv>\r
28 <refsect1 id="parameters"><title>Parameters</title>\r
29 <variablelist>\r
30 <varlistentry>\r
31 <term><parameter>n</parameter></term>\r
32 <listitem>\r
33 <para>\r
34 Specifies the number of sampler objects to be deleted.\r
35 </para>\r
36 </listitem>\r
37 </varlistentry>\r
38 <varlistentry>\r
39 <term><parameter>samplers</parameter></term>\r
40 <listitem>\r
41 <para>\r
42 Specifies an array of sampler objects to be deleted.\r
43 </para>\r
44 </listitem>\r
45 </varlistentry>\r
46 </variablelist>\r
47 </refsect1>\r
48 <refsect1 id="description"><title>Description</title>\r
49 <para>\r
50 <function>glDeleteSamplers</function> deletes <parameter>n</parameter> sampler objects named by the elements of the array <parameter>samplers</parameter>.\r
51 After a sampler object is deleted, its name is again unused. If a sampler object that is currently bound to a sampler unit is deleted, it is as\r
52 though <citerefentry><refentrytitle>glBindSampler</refentrytitle></citerefentry> is called with unit set to the unit the sampler is bound to and\r
53 sampler zero. Unused names in samplers are silently ignored, as is the reserved name zero.\r
54 </para>\r
55 </refsect1>\r
56 <refsect1 id="notes"><title>Notes</title>\r
57 <para>\r
58 <function>glDeleteSamplers</function> is available only if the GL version is 3.3 or higher.\r
59 </para>\r
60 </refsect1>\r
61 <refsect1 id="errors"><title>Errors</title>\r
62 <para>\r
63 <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.\r
64 </para>\r
65 </refsect1>\r
66 <refsect1 id="associatedgets"><title>Associated Gets</title>\r
67 <para>\r
68 <citerefentry><refentrytitle>glIsSampler</refentrytitle></citerefentry>\r
69 </para>\r
70 </refsect1>\r
71 <refsect1 id="seealso"><title>See Also</title>\r
72 <para>\r
73 <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>,\r
74 <citerefentry><refentrytitle>glBindSampler</refentrytitle></citerefentry>,\r
75 <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>,\r
76 <citerefentry><refentrytitle>glIsSampler</refentrytitle></citerefentry>\r
77 </para>\r
78 </refsect1>\r
79 <refsect1 id="Copyright"><title>Copyright</title>\r
80 <para>\r
81 Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
82 This material may be distributed subject to the terms and conditions set forth in \r
83 the Open Publication License, v 1.0, 8 June 1999.\r
84 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
85 </para>\r
86 </refsect1>\r
87</refentry>\r