Commit | Line | Data |
---|---|---|
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="glInvalidateBufferSubData">\r | |
5 | <refmeta>\r | |
6 | <refmetainfo>\r | |
7 | <copyright>\r | |
8 | <year>2012</year>\r | |
9 | <holder>Khronos Group</holder>\r | |
10 | </copyright>\r | |
11 | </refmetainfo>\r | |
12 | <refentrytitle>glInvalidateBufferSubData</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>glInvalidateBufferSubData</refname>\r | |
17 | <refpurpose>invalidate a region of a buffer object's data store</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>C Specification</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>void <function>glInvalidateBufferSubData</function></funcdef>\r | |
23 | <paramdef>GLuint <parameter>buffer</parameter></paramdef>\r | |
24 | <paramdef>GLintptr <parameter>offset</parameter></paramdef>\r | |
25 | <paramdef>GLsizeiptr <parameter>length</parameter></paramdef>\r | |
26 | </funcprototype>\r | |
27 | </funcsynopsis>\r | |
28 | </refsynopsisdiv>\r | |
29 | <refsect1 id="parameters"><title>Parameters</title>\r | |
30 | <variablelist>\r | |
31 | <varlistentry>\r | |
32 | <term><parameter>buffer</parameter></term>\r | |
33 | <listitem>\r | |
34 | <para>\r | |
35 | The name of a buffer object, a subrange of whose data store to invalidate.\r | |
36 | </para>\r | |
37 | </listitem>\r | |
38 | </varlistentry>\r | |
39 | <varlistentry>\r | |
40 | <term><parameter>offset</parameter></term>\r | |
41 | <listitem>\r | |
42 | <para>\r | |
43 | The offset within the buffer's data store of the start of the range to be invalidated.\r | |
44 | </para>\r | |
45 | </listitem>\r | |
46 | </varlistentry>\r | |
47 | <varlistentry>\r | |
48 | <term><parameter>length</parameter></term>\r | |
49 | <listitem>\r | |
50 | <para>\r | |
51 | The length of the range within the buffer's data store to be invalidated.\r | |
52 | </para>\r | |
53 | </listitem>\r | |
54 | </varlistentry>\r | |
55 | </variablelist>\r | |
56 | </refsect1>\r | |
57 | <refsect1 id="description"><title>Description</title>\r | |
58 | <para>\r | |
59 | <function>glInvalidateBufferSubData</function> invalidates all or part of the\r | |
60 | content of the data store of a buffer object. After invalidation, the content\r | |
61 | of the specified range of the buffer's data store becomes undefined. The\r | |
62 | start of the range is given by <parameter>offset</parameter> and its size\r | |
63 | is given by <parameter>length</parameter>, both measured in basic machine units.\r | |
64 | </para>\r | |
65 | </refsect1>\r | |
66 | <refsect1 id="errors"><title>Errors</title>\r | |
67 | <para>\r | |
68 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>offset</parameter> or\r | |
69 | <parameter>length</parameter> is negative, or if <parameter>offset</parameter> +\r | |
70 | <parameter>length</parameter> is greater than the value of <constant>GL_BUFFER_SIZE</constant>\r | |
71 | for <parameter>buffer</parameter>.\r | |
72 | </para>\r | |
73 | <para>\r | |
74 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>buffer</parameter> is not the\r | |
75 | name of an existing buffer object.\r | |
76 | </para>\r | |
77 | <para>\r | |
78 | <constant>GL_INVALID_OPERATION</constant> is generated if any part of <parameter>buffer</parameter>\r | |
79 | is currently mapped.\r | |
80 | </para>\r | |
81 | </refsect1>\r | |
82 | <refsect1 id="associatedgets"><title>Associated Gets</title>\r | |
83 | <para>\r | |
84 | <citerefentry><refentrytitle>glGetBufferParameter</refentrytitle></citerefentry> with argument <constant>GL_BUFFER_SIZE</constant>\r | |
85 | </para>\r | |
86 | </refsect1>\r | |
87 | <refsect1 id="seealso"><title>See Also</title>\r | |
88 | <para>\r | |
89 | <citerefentry><refentrytitle>glInvalidateTexSubImage</refentrytitle></citerefentry>,,\r | |
90 | <citerefentry><refentrytitle>glInvalidateTexImage</refentrytitle></citerefentry>,\r | |
91 | <citerefentry><refentrytitle>glInvalidateBufferData</refentrytitle></citerefentry>,\r | |
92 | <citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>,\r | |
93 | <citerefentry><refentrytitle>glInvalidateSubFramebuffer</refentrytitle></citerefentry>.\r | |
94 | </para>\r | |
95 | </refsect1>\r | |
96 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
97 | <para>\r | |
98 | Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r | |
99 | This material may be distributed subject to the terms and conditions set forth in \r | |
100 | the Open Publication License, v 1.0, 8 June 1999.\r | |
101 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
102 | </para>\r | |
103 | </refsect1>\r | |
104 | </refentry>\r |