Difference between revisions of "GLAPI/glBufferSubData"

From OpenGL.org
Jump to: navigation, search
m (fixed sort key)
(Function Definition)
(13 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
== Function Definition ==
 
== Function Definition ==
  
   void '''glBufferSubData'''(GLenum ''target'', GLintptr ''offset'', GLsizeiptr ''size'', const GLvoid * ''data'');
+
   void '''glBufferSubData'''(GLenum {{param|target}}, GLintptr {{param|offset}}, GLsizeiptr {{param|size}}, const GLvoid * {{param|data}});
  
; target
+
{{glapi indexbuffertargets}}
: Specifies the target buffer object. The symbolic constant must be {{code|GL_ARRAY_BUFFER}}, {{code|GL_COPY_READ_BUFFER}}, {{code|GL_COPY_WRITE_BUFFER}}, {{code|GL_ELEMENT_ARRAY_BUFFER}}, {{code|GL_PIXEL_PACK_BUFFER}}, {{code|GL_PIXEL_UNPACK_BUFFER}}, {{code|GL_TEXTURE_BUFFER}}, {{code|GL_TRANSFORM_FEEDBACK_BUFFER}}, or {{code|GL_UNIFORM_BUFFER}}.
+
 
; offset
 
; offset
 
: Specifies the offset into the buffer object's data store where data replacement will begin, measured in bytes.
 
: Specifies the offset into the buffer object's data store where data replacement will begin, measured in bytes.
Line 21: Line 20:
 
== Description ==
 
== Description ==
  
'''glBufferSubData''' redefines some or all of the data store for the buffer object currently bound to ''target''. Data starting at byte offset ''offset'' and extending for ''size'' bytes is copied to the data store from the memory pointed to by ''data''. An error is thrown if ''offset'' and ''size'' together define a range beyond the bounds of the buffer object's data store.
+
'''glBufferSubData''' redefines some or all of the data store for the buffer object currently bound to {{param|target}}. Data starting at byte offset {{param|offset}} and extending for {{param|size}} bytes is copied to the data store from the memory pointed to by {{param|data}}. An error is thrown if {{param|offset}} and {{param|size}} together define a range beyond the bounds of the buffer object's data store.
  
 
== Notes ==
 
== Notes ==
Line 29: Line 28:
 
Consider using multiple buffer objects to avoid stalling the rendering pipeline during data store updates. If any rendering in the pipeline makes reference to data in the buffer object being updated by '''glBufferSubData''', especially from the specific region being updated, that rendering must drain from the pipeline before the data store can be updated.
 
Consider using multiple buffer objects to avoid stalling the rendering pipeline during data store updates. If any rendering in the pipeline makes reference to data in the buffer object being updated by '''glBufferSubData''', especially from the specific region being updated, that rendering must drain from the pipeline before the data store can be updated.
  
Clients must align data elements consistent with the requirements of the client platform, with an additional base-level requirement that an offset within a buffer to a datum comprising <!--Missing Equation-->.
+
Clients must align data elements consistent with the requirements of the client platform, with an additional base-level requirement that an offset within a buffer to a datum comprising N bytes be a multiple of N.
 +
 
 +
The {{enum|GL_ATOMIC_COUNTER_BUFFER}} target is available only if the GL version is 4.2 or greater.
 +
 
 +
The {{enum|GL_DISPATCH_INDIRECT_BUFFER}} and {{enum|GL_SHADER_STORAGE_BUFFER}} targets are available only if the GL version is 4.3 or greater.
  
 
== Errors ==
 
== Errors ==
  
{{code|GL_INVALID_ENUM}} is generated if ''target'' is not one of the accepted buffer targets.
+
{{enum|GL_INVALID_ENUM}} is generated if {{param|target}} is not one of the accepted buffer targets.
  
{{code|GL_INVALID_VALUE}} is generated if ''offset'' or ''size'' is negative, or if together they define a region of memory that extends beyond the buffer object's allocated data store.
+
{{enum|GL_INVALID_VALUE}} is generated if {{param|offset}} or {{param|size}} is negative, or if together they define a region of memory that extends beyond the buffer object's allocated data store.
  
{{code|GL_INVALID_OPERATION}} is generated if the reserved buffer object name 0 is bound to ''target''.
+
{{enum|GL_INVALID_OPERATION}} is generated if the reserved buffer object name 0 is bound to {{param|target}}.
  
{{code|GL_INVALID_OPERATION}} is generated if the buffer object being updated is mapped.
+
{{enum|GL_INVALID_OPERATION}} is generated if the buffer object being updated is mapped.
  
 
== Associated Gets ==
 
== Associated Gets ==
  
[[GLAPI/glGetBufferSubData|glGetBufferSubData]]
+
{{apifunc|glGetBufferSubData}}
  
 
== See Also ==
 
== See Also ==
  
[[GLAPI/glBindBuffer|glBindBuffer]], [[GLAPI/glBufferData|glBufferData]], [[GLAPI/glMapBuffer|glMapBuffer]], [[GLAPI/glUnmapBuffer|glUnmapBuffer]]
+
{{apifunc|glBindBuffer}}, {{apifunc|glBufferData}}, {{apifunc|glInvalidateBufferSubData}}, {{apifunc|glClearBufferSubData}}, {{apifunc|glCopyBufferSubData}}, {{apifunc|glMapBufferRange}}, {{apifunc|glUnmapBuffer}}
  
 
== Copyright ==
 
== Copyright ==
Line 53: Line 56:
 
Copyright © 2005 Addison-Wesley. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].
 
Copyright © 2005 Addison-Wesley. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].
  
[[Category:API Reference 4|BufferSubData]]
+
[[Category:Core API Ref Buffer Objects|BufferSubData]]
 +
[[Category:Core API Reference|BufferSubData]]

Revision as of 10:49, 6 September 2012

glBufferSubData
Core in version 4.5
Core since version 1.5

glBufferSubData: updates a subset of a buffer object's data store

Function Definition

 void glBufferSubData(GLenum target​, GLintptr offset​, GLsizeiptr size​, const GLvoid * data​);
target
Specifies the target buffer object. The symbolic constant must be GL_ATOMIC_COUNTER_BUFFER, GL_TRANSFORM_FEEDBACK_BUFFER, GL_UNIFORM_BUFFER or GL_SHADER_STORAGE_BUFFER.
offset
Specifies the offset into the buffer object's data store where data replacement will begin, measured in bytes.
size
Specifies the size in bytes of the data store region being replaced.
data
Specifies a pointer to the new data that will be copied into the data store.

Description

glBufferSubData redefines some or all of the data store for the buffer object currently bound to target​. Data starting at byte offset offset​ and extending for size​ bytes is copied to the data store from the memory pointed to by data​. An error is thrown if offset​ and size​ together define a range beyond the bounds of the buffer object's data store.

Notes

When replacing the entire data store, consider using glBufferSubData rather than completely recreating the data store with glBufferData. This avoids the cost of reallocating the data store.

Consider using multiple buffer objects to avoid stalling the rendering pipeline during data store updates. If any rendering in the pipeline makes reference to data in the buffer object being updated by glBufferSubData, especially from the specific region being updated, that rendering must drain from the pipeline before the data store can be updated.

Clients must align data elements consistent with the requirements of the client platform, with an additional base-level requirement that an offset within a buffer to a datum comprising N bytes be a multiple of N.

The GL_ATOMIC_COUNTER_BUFFER target is available only if the GL version is 4.2 or greater.

The GL_DISPATCH_INDIRECT_BUFFER and GL_SHADER_STORAGE_BUFFER targets are available only if the GL version is 4.3 or greater.

Errors

GL_INVALID_ENUM is generated if target​ is not one of the accepted buffer targets.

GL_INVALID_VALUE is generated if offset​ or size​ is negative, or if together they define a region of memory that extends beyond the buffer object's allocated data store.

GL_INVALID_OPERATION is generated if the reserved buffer object name 0 is bound to target​.

GL_INVALID_OPERATION is generated if the buffer object being updated is mapped.

Associated Gets

glGetBufferSubData

See Also

glBindBuffer, glBufferData, glInvalidateBufferSubData, glClearBufferSubData, glCopyBufferSubData, glMapBufferRange, glUnmapBuffer

Copyright

Copyright © 2005 Addison-Wesley. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.