Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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="glGenBuffers"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>2005</year> | |
9 | <holder>Sams Publishing</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glGenBuffers</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glGenBuffers</refname> | |
17 | <refpurpose>generate buffer object names</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glGenBuffers</function></funcdef> | |
23 | <paramdef>GLsizei <parameter>n</parameter></paramdef> | |
24 | <paramdef>GLuint * <parameter>buffers</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 buffer object names to be generated. | |
35 | </para> | |
36 | </listitem> | |
37 | </varlistentry> | |
38 | <varlistentry> | |
39 | <term><parameter>buffers</parameter></term> | |
40 | <listitem> | |
41 | <para> | |
42 | Specifies an array in which the generated buffer object names are stored. | |
43 | </para> | |
44 | </listitem> | |
45 | </varlistentry> | |
46 | </variablelist> | |
47 | </refsect1> | |
48 | <refsect1 id="description"><title>Description</title> | |
49 | <para> | |
50 | <function>glGenBuffers</function> returns <parameter>n</parameter> buffer object names in <parameter>buffers</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>glGenBuffers</function>. | |
54 | </para> | |
55 | <para> | |
56 | Buffer object names returned by a call to <function>glGenBuffers</function> are not returned by | |
57 | subsequent calls, unless they are first deleted with | |
58 | <citerefentry><refentrytitle>glDeleteBuffers</refentrytitle></citerefentry>. | |
59 | </para> | |
60 | <para> | |
61 | No buffer objects are associated with the returned buffer object names until they are first bound by calling | |
62 | <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>. | |
63 | </para> | |
64 | </refsect1> | |
65 | <refsect1 id="notes"><title>Notes</title> | |
66 | <para> | |
67 | <function>glGenBuffers</function> is available only if the GL version is 1.5 or greater. | |
68 | </para> | |
69 | </refsect1> | |
70 | <refsect1 id="errors"><title>Errors</title> | |
71 | <para> | |
72 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative. | |
73 | </para> | |
74 | <para> | |
75 | <constant>GL_INVALID_OPERATION</constant> is generated if <function>glGenBuffers</function> is executed | |
76 | between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding | |
77 | execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>. | |
78 | </para> | |
79 | </refsect1> | |
80 | <refsect1 id="associatedgets"><title>Associated Gets</title> | |
81 | <para> | |
82 | <citerefentry><refentrytitle>glIsBuffer</refentrytitle></citerefentry> | |
83 | </para> | |
84 | </refsect1> | |
85 | <refsect1 id="seealso"><title>See Also</title> | |
86 | <para> | |
87 | <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>, | |
88 | <citerefentry><refentrytitle>glDeleteBuffers</refentrytitle></citerefentry>, | |
89 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> | |
90 | </para> | |
91 | </refsect1> | |
92 | <refsect1 id="Copyright"><title>Copyright</title> | |
93 | <para> | |
94 | Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley. | |
95 | This material may be distributed subject to the terms and conditions set forth in | |
96 | the Open Publication License, v 1.0, 8 June 1999. | |
97 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
98 | </para> | |
99 | </refsect1> | |
100 | </refentry> |