glBufferSubData : PyOpenGL 3.1.4 GL Man Pages

updates a subset of a buffer object's data store

Signature

glBufferSubData( GLenum ( target ) , GLintptr ( offset ) , GLsizeiptr ( size ) , const void * ( data ) )-> void

glBufferSubData( target , offset , size , data )

Copy subset of data into the currently bound vertex-buffer-data object

    target -- the symbolic constant indicating which buffer type is intended
    offset -- offset from beginning of buffer at which to copy bytes
    size -- the count-in-bytes of the array (if an int/long), if None,
        calculate size from data, if an array and data is None, use as
        data (i.e. the parameter can be omitted and calculated)
    data -- data-pointer to be used, may be None to initialize without
        copying over a data-set

    Note that if size is not an int/long it is considered to be data
    *iff* data is None

glNamedBufferSubData( GLuint ( buffer ) , GLintptr ( offset ) , GLsizeiptr ( size ) , const void *( data ) )-> void

glNamedBufferSubData( buffer , offset , size , data )

Parameters

Variables	Description
target	Specifies the target to which the buffer object is bound for glBufferSubData , which must be one of the buffer binding targets in the following table:
buffer	Specifies the name of the buffer object for glNamedBufferSubData .
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 and glNamedBufferSubData redefine some or all of the data store for the specified buffer object. Data starting at byte offset offset and extending for size bytes is copied to the data store from the memory pointed to by data . offset and size must define a range lying entirely within 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.

The GL_QUERY_BUFFER target is available only if the GL version is 4.4 or greater.

Errors

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

GL_INVALID_OPERATION is generated by glBufferSubData if zero is bound to target .

GL_INVALID_OPERATION is generated by glNamedBufferSubData if buffer is not the name of an existing buffer object.

GL_INVALID_VALUE is generated if offset or size is negative, or if $offset + size$ is greater than the value of GL_BUFFER_SIZE for the specified buffer object.

GL_INVALID_OPERATION is generated if any part of the specified range of the buffer object is mapped with glMapBufferRange or glMapBuffer , unless it was mapped with the GL_MAP_PERSISTENT_BIT bit set in the glMapBufferRange access flags.

GL_INVALID_OPERATION is generated if the value of the GL_BUFFER_IMMUTABLE_STORAGE flag of the buffer object is GL_TRUE and the value of GL_BUFFER_STORAGE_FLAGS for the buffer object does not have the GL_DYNAMIC_STORAGE_BIT bit set.

Associated Gets

glGetBufferSubData

Version Support

glBufferSubData
glNamedBufferSubData

Copyright

2005 Addison-Wesley. Copyright

2010-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.

http://opencontent.org/openpub/

Sample Code References

The following code samples have been found which appear to reference the functions described here. Take care that the code may be old, broken or not even use PyOpenGL.

glBufferSubData

{LGPL} Pyggel pyggel/data.py Lines: 416, 424, 432, 440