glClearBufferSubData

From OpenGL Reference
Jump to navigation Jump to search

Fill all or part of buffer object's data store with a fixed value.

C Specification[edit]

void glClearBufferSubData( GLenum target, GLenum internalformat, GLintptr offset, GLsizeiptr size, GLenum format, GLenum type, const void * data );
void glClearNamedBufferSubData( GLuint buffer, GLenum internalformat, GLintptr offset, GLsizeiptr size, GLenum format, GLenum type, const void * data );


Parameters[edit]

target - Specifies the target to which the buffer object is bound for glClearBufferSubData , which must be one of the buffer binding targets in the following table:
buffer - Specifies the name of the buffer object for glClearNamedBufferSubData .
internalformat - The internal format with which the data will be stored in the buffer object.
offset - The offset in basic machine units into the buffer object's data store at which to start filling.
size - The size in basic machine units of the range of the data store to fill.
format - The format of the data in memory addressed by data .
type - The type of the data in memory addressed by data .
data - The address of a memory location storing the data to be replicated into the buffer's data store.


Description[edit]

 glClearBufferSubData and glClearNamedBufferSubData fill a specified region of a buffer object's data store with data from client memory.

 offset and size specify the extent of the region within the data store of the buffer object to fill with data. Data, initially supplied in a format specified by format in data type type is read from the memory address given by data and converted into the internal representation given by internalformat , which must be one of the following sized internal formats:

This converted data is then replicated throughout the specified region of the buffer object's data store. If data is NULL, then the subrange of the buffer's data store is filled with zeros.


Errors[edit]

 GL_INVALID_ENUM is generated by glClearBufferSubData if target is not one of the generic buffer binding targets.

 GL_INVALID_VALUE is generated by glClearBufferSubData if no buffer is bound to target .

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

 GL_INVALID_ENUM is generated if internalformat is not one of the valid sized internal formats listed in the table above.

 GL_INVALID_VALUE is generated if offset or range are not multiples of the number of basic machine units per-element for the internal format specified by internalformat . This value may be computed by multiplying the number of components for internalformat from the table by the size of the base type from the table.

 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 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_VALUE is generated if format is not a valid format, or type is not a valid type.


Version Support[edit]

 glClearBufferSubData  4.3+
 glClearNamedBufferSubData  4.5+

See Also[edit]

 glClearBufferData .


Copyright[edit]

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. http://opencontent.org/openpub/.