1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glBufferStorage">
<info>
<copyright>
<year>2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glBufferStorage</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glBufferStorage</refname>
<refname>glNamedBufferStorage</refname>
<refpurpose>creates and initializes a buffer object's immutable data
store</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glBufferStorage</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLsizeiptr <parameter>size</parameter></paramdef>
<paramdef>const GLvoid * <parameter>data</parameter></paramdef>
<paramdef>GLbitfield <parameter>flags</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glNamedBufferStorage</function></funcdef>
<paramdef>GLuint <parameter>buffer</parameter></paramdef>
<paramdef>GLsizei <parameter>size</parameter></paramdef>
<paramdef>const void *<parameter>data</parameter></paramdef>
<paramdef>GLbitfield <parameter>flags</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
Specifies the target to which the buffer object is bound for
<function>glBufferStorage</function>, which must be one of the
buffer binding targets in the following table:
</para>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="bufferbindings.xml"/>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>Specifies the name of the buffer object for
<function>glNamedBufferStorage</function> function.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>Specifies the size in bytes of the buffer object's new data
store.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>Specifies a pointer to data that will be copied into the data
store for initialization, or <constant>NULL</constant> if no data is
to be copied.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>Specifies the intended usage of the buffer's data store. Must
be a bitwise combination of the following flags.
<constant>GL_DYNAMIC_STORAGE_BIT</constant>,
<constant>GL_MAP_READ_BIT</constant>
<constant>GL_MAP_WRITE_BIT</constant>,
<constant>GL_MAP_PERSISTENT_BIT</constant>,
<constant>GL_MAP_COHERENT_BIT</constant>, and
<constant>GL_CLIENT_STORAGE_BIT</constant>.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description">
<title>Description</title>
<para><function>glBufferStorage</function> and
<function>glNamedBufferStorage</function> create a new immutable data
store. For <function>glBufferStorage</function>, the buffer object
currently bound to <parameter>target</parameter> will be initialized. For
<function>glNamedBufferStorage</function>, <parameter>buffer</parameter>
is the name of the buffer object that will be configured. The size of the
data store is specified by <parameter>size</parameter>. If an initial data
is available, its address may be supplied in <parameter>data</parameter>.
Otherwise, to create an uninitialized data store,
<parameter>data</parameter> should be <constant>NULL</constant>.</para>
<para>The <parameter>flags</parameter> parameters specifies the intended
usage of the buffer's data store. It must be a bitwise combination of a
subset of the following flags: <variablelist>
<varlistentry>
<term><constant>GL_DYNAMIC_STORAGE_BIT</constant></term>
<listitem>
<para>The contents of the data store may be updated after creation
through calls to
<citerefentry><refentrytitle>glBufferSubData</refentrytitle></citerefentry>.
If this bit is not set, the buffer content may
not be directly updated by the client. The data argument may be
used to specify the initial content of the buffer's data store
regardless of the presence of the
<constant>GL_DYNAMIC_STORAGE_BIT</constant>. Regardless of the
presence of this bit, buffers may always be updated with
server-side calls such as
<citerefentry><refentrytitle>glCopyBufferSubData</refentrytitle></citerefentry>
and
<citerefentry><refentrytitle>glClearBufferSubData</refentrytitle></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_MAP_READ_BIT</constant></term>
<listitem>
<para>The data store may be mapped by the client for read access
and a pointer in the client's address space obtained that may be
read from.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_MAP_WRITE_BIT</constant></term>
<listitem>
<para>The data store may be mapped by the client for write access
and a pointer in the client's address space obtained that may be
written through.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_MAP_PERSISTENT_BIT</constant></term>
<listitem>
<para>The client may request that the server read from or write to
the buffer while it is mapped. The client's pointer to the data
store remains valid so long as the data store is mapped, even
during execution of drawing or dispatch commands.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_MAP_COHERENT_BIT</constant></term>
<listitem>
<para>Shared access to buffers that are simultaneously mapped for
client access and are used by the server will be coherent, so long
as that mapping is performed using
<citerefentry><refentrytitle>glMapBufferRange</refentrytitle></citerefentry>.
That is, data written to the store by either
the client or server will be immediately visible to the other with
no further action taken by the application. In particular,</para>
<itemizedlist>
<listitem>
<para>If <constant>GL_MAP_COHERENT_BIT</constant> is not set
and the client performs a write followed by a call to the
<citerefentry><refentrytitle>glMemoryBarrier</refentrytitle></citerefentry>
command with the
<constant>GL_CLIENT_MAPPED_BUFFER_BARRIER_BIT</constant> set,
then in subsequent commands the server will see the
writes.</para>
</listitem>
<listitem>
<para>If <constant>GL_MAP_COHERENT_BIT</constant> is set and
the client performs a write, then in subsequent commands the
server will see the writes.</para>
</listitem>
<listitem>
<para>If <constant>GL_MAP_COHERENT_BIT</constant> is not set
and the server performs a write, the application must call
<citerefentry><refentrytitle>glMemoryBarrier</refentrytitle></citerefentry>
with the <constant>GL_CLIENT_MAPPED_BUFFER_BARRIER_BIT</constant> set
and then call
<citerefentry><refentrytitle>glFenceSync</refentrytitle></citerefentry>
with <constant>GL_SYNC_GPU_COMMANDS_COMPLETE</constant> (or <function>glFinish</function>). Then the CPU will see the writes after the sync is complete.</para>
</listitem>
<listitem>
<para>If <constant>GL_MAP_COHERENT_BIT</constant> is set and
the server does a write, the app must call <function>glFenceSync</function> with
<constant>GL_SYNC_GPU_COMMANDS_COMPLETE</constant> (or
<citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>).
Then the CPU will see the writes after the
sync is complete.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_CLIENT_STORAGE_BIT</constant></term>
<listitem>
<para>When all other criteria for the buffer storage allocation
are met, this bit may be used by an implementation to determine
whether to use storage that is local to the server or to the
client to serve as the backing store for the buffer.</para>
</listitem>
</varlistentry>
</variablelist></para>
<para>The allowed combinations of flags are subject to certain
restrictions. They are as follows: <itemizedlist>
<listitem>
<para>If <parameter>flags</parameter> contains
<constant>GL_MAP_PERSISTENT_BIT</constant>, it must also contain at
least one of <constant>GL_MAP_READ_BIT</constant> or
<constant>GL_MAP_WRITE_BIT</constant>.</para>
</listitem>
<listitem>
<para>If <parameter>flags</parameter> contains
<constant>GL_MAP_COHERENT_BIT</constant>, it must also contain
<constant>GL_MAP_PERSISTENT_BIT</constant>.</para>
</listitem>
</itemizedlist></para>
</refsect1>
<refsect1 xml:id="notes">
<title>Notes</title>
<para><function>glBufferStorage</function> is available only if the GL
version is 4.4 or greater.</para>
<para><function>glNamedBufferStorage</function> is available only if the
GL version is 4.5 or greater.</para>
<para>If <parameter>data</parameter> is <constant>NULL</constant>, a data
store of the specified size is still created, but its contents remain
uninitialized and thus undefined.</para>
</refsect1>
<refsect1 xml:id="errors">
<title>Errors</title>
<para><constant>GL_INVALID_ENUM</constant> is generated by
<function>glBufferStorage</function> if <parameter>target</parameter> is
not one of the accepted buffer targets.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated by
<function>glNamedBufferStorage</function> if buffer is not the name of an
existing buffer object.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>size</parameter> is less than or equal to zero.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated by
<function>glBufferStorage</function> if the reserved buffer object name 0
is bound to <parameter>target</parameter>.</para>
<para><constant>GL_OUT_OF_MEMORY</constant> is generated if the GL is
unable to create a data store with the properties requested in
<parameter>flags</parameter>.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>flags</parameter> has any bits set other than those defined
above.</para>
<para><constant>GL_INVALID_VALUE</constant> error is generated if
<parameter>flags</parameter> contains
<constant>GL_MAP_PERSISTENT_BIT</constant> but does not contain at least
one of <constant>GL_MAP_READ_BIT</constant> or
<constant>GL_MAP_WRITE_BIT</constant>.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>flags</parameter> contains
<constant>GL_MAP_COHERENT_BIT</constant>, but does not also contain
<constant>GL_MAP_PERSISTENT_BIT</constant>.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated by
<function>glBufferStorage</function> if the
<constant>GL_BUFFER_IMMUTABLE_STORAGE</constant> flag of the buffer bound
to <parameter>target</parameter> is <constant>GL_TRUE</constant>.</para>
</refsect1>
<refsect1 xml:id="associatedgets">
<title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGetBufferSubData</refentrytitle></citerefentry>
</para>
<para><citerefentry><refentrytitle>glGetBufferParameter</refentrytitle></citerefentry>
with argument <constant>GL_BUFFER_SIZE</constant> or
<constant>GL_BUFFER_USAGE</constant></para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glBufferStorage</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='44']/*)"/>
</row>
<row>
<entry><function>glNamedBufferStorage</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso">
<title>See Also</title>
<para>
<citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glBufferSubData</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2014 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|
