GLAPI/glClearBufferSubData

From OpenGL.org
Jump to: navigation, search
glClearBufferSubData
Core in version 4.4
Core since version 4.3
Core ARB extension ARB_clear_buffer_object

glClearBufferSubData: fill all or part of buffer object's data store with a fixed value

Function Definition

 void glClearBufferSubData(GLenum target​, GLenum internalformat​, GLintptr offset​, GLsizeiptr size​, GLenum format​, GLenum type​, const void * data​);
target
Specifies the target buffer object. The symbolic constant must be GL_ARRAY_BUFFER​, GL_ATOMIC_COUNTER_BUFFER​, GL_COPY_READ_BUFFER​, GL_COPY_WRITE_BUFFER​, GL_DRAW_INDIRECT_BUFFER​, GL_DISPATCH_INDIRECT_BUFFER​, GL_ELEMENT_ARRAY_BUFFER​, GL_PIXEL_PACK_BUFFER​, GL_PIXEL_UNPACK_BUFFER​, GL_QUERY_BUFFER​, GL_SHADER_STORAGE_BUFFER​, GL_TEXTURE_BUFFER​, GL_TRANSFORM_FEEDBACK_BUFFER​, or GL_UNIFORM_BUFFER​.
internalformat
The sized 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
Specifies the format of the pixel data. For transfers of depth, stencil, or depth/stencil data, you must use GL_DEPTH_COMPONENT​, GL_STENCIL_INDEX​, or GL_DEPTH_STENCIL​, where appropriate. For transfers of normalized integer or floating-point color image data, you must use one of the following: GL_RED​, GL_GREEN​, GL_BLUE​, GL_RG​, GL_RGB​, GL_BGR​, GL_RGBA​, and GL_BGRA​. For transfers of non-normalized integer data, you must use one of the following: GL_RED_INTEGER​, GL_GREEN_INTEGER​, GL_BLUE_INTEGER​, GL_RG_INTEGER​, GL_RGB_INTEGER​, GL_BGR_INTEGER​, GL_RGBA_INTEGER​, and GL_BGRA_INTEGER​.
type
Specifies the data type of the pixel data. The following symbolic values are accepted: GL_UNSIGNED_BYTE​, GL_BYTE​, GL_UNSIGNED_SHORT​, GL_SHORT​, GL_UNSIGNED_INT​, GL_INT​, GL_FLOAT​, GL_UNSIGNED_BYTE_3_3_2​, GL_UNSIGNED_BYTE_2_3_3_REV​, GL_UNSIGNED_SHORT_5_6_5​, GL_UNSIGNED_SHORT_5_6_5_REV​, GL_UNSIGNED_SHORT_4_4_4_4​, GL_UNSIGNED_SHORT_4_4_4_4_REV​, GL_UNSIGNED_SHORT_5_5_5_1​, GL_UNSIGNED_SHORT_1_5_5_5_REV​, GL_UNSIGNED_INT_8_8_8_8​, GL_UNSIGNED_INT_8_8_8_8_REV​, GL_UNSIGNED_INT_10_10_10_2​, and GL_UNSIGNED_INT_2_10_10_10_REV​.
data
Specifies a pointer to a single pixel of data to upload. This parameter may not be NULL.


Description

glClearBufferSubData fills a specified region of a buffer object's data store with data from client memory. offset​ and size​ demark the extent of the region within the data store of the buffer object bound to target​ 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 internalforamt​. 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

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

GL_INVALID_VALUE​ is generated if no buffer is bound to target​.

GL_INVALID_ENUM​ is generated if internalformat​ is not a sized internal format.

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

GL_INVALID_VALUE​ is generated if offset​ or size​ is less than zero, or if offset​ + size​ is greater than the value of GL_BUFFER_SIZE​ for the buffer bound to target​.

GL_INVALID_OPERATION​ is generated if any part of the specified buffer range is mapped with glMapBufferRange or glMapBuffer.

See Also

glBindBuffer, glBufferSubData, glInvalidateBufferSubData, glClearBufferData, glCopyBufferSubData, glMapBufferRange, glUnmapBuffer

Copyright

Copyright © 2012 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/.