3f1738fb9cf9199e7a54a61df7e816213b821ead
[clinton/guile-figl.git] / upstream-man-pages / man4 / glInvalidateBufferData.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="glInvalidateBufferData">
5 <refmeta>
6 <refmetainfo>
7 <copyright>
8 <year>2012</year>
9 <holder>Khronos Group</holder>
10 </copyright>
11 </refmetainfo>
12 <refentrytitle>glInvalidateBufferData</refentrytitle>
13 <manvolnum>3G</manvolnum>
14 </refmeta>
15 <refnamediv>
16 <refname>glInvalidateBufferData</refname>
17 <refpurpose>invalidate the content of a buffer object's data store</refpurpose>
18 </refnamediv>
19 <refsynopsisdiv><title>C Specification</title>
20 <funcsynopsis>
21 <funcprototype>
22 <funcdef>void <function>glInvalidateBufferData</function></funcdef>
23 <paramdef>GLuint <parameter>buffer</parameter></paramdef>
24 </funcprototype>
25 </funcsynopsis>
26 </refsynopsisdiv>
27 <refsect1 id="parameters"><title>Parameters</title>
28 <variablelist>
29 <varlistentry>
30 <term><parameter>buffer</parameter></term>
31 <listitem>
32 <para>
33 The name of a buffer object whose data store to invalidate.
34 </para>
35 </listitem>
36 </varlistentry>
37 </variablelist>
38 </refsect1>
39 <refsect1 id="description"><title>Description</title>
40 <para>
41 <function>glInvalidateBufferData</function> invalidates all of the
42 content of the data store of a buffer object. After invalidation, the content
43 of the buffer's data store becomes undefined.
44 </para>
45 </refsect1>
46 <refsect1 id="errors"><title>Errors</title>
47 <para>
48 <constant>GL_INVALID_VALUE</constant> is generated if <parameter>buffer</parameter> is not the
49 name of an existing buffer object.
50 </para>
51 <para>
52 <constant>GL_INVALID_OPERATION</constant> is generated if any part of <parameter>buffer</parameter>
53 is currently mapped.
54 </para>
55 </refsect1>
56 <refsect1 id="associatedgets"><title>Associated Gets</title>
57 <para>
58 <citerefentry><refentrytitle>glGetBufferParameter</refentrytitle></citerefentry> with argument <constant>GL_BUFFER_SIZE</constant>
59 </para>
60 </refsect1>
61 <refsect1 id="seealso"><title>See Also</title>
62 <para>
63 <citerefentry><refentrytitle>glInvalidateTexSubImage</refentrytitle></citerefentry>,,
64 <citerefentry><refentrytitle>glInvalidateTexImage</refentrytitle></citerefentry>,
65 <citerefentry><refentrytitle>glInvalidateBufferSubData</refentrytitle></citerefentry>,
66 <citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>,
67 <citerefentry><refentrytitle>glInvalidateSubFramebuffer</refentrytitle></citerefentry>.
68 </para>
69 </refsect1>
70 <refsect1 id="Copyright"><title>Copyright</title>
71 <para>
72 Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
73 This material may be distributed subject to the terms and conditions set forth in
74 the Open Publication License, v 1.0, 8 June 1999.
75 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
76 </para>
77 </refsect1>
78 </refentry>