GLAPI/glClearBufferData: Difference between revisions
Bot: Adding better formatting. |
m Removed the size parameter description, as it is not part of the function call. |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 9: | Line 9: | ||
== Function Definition == | == Function Definition == | ||
void '''glClearBufferData'''(GLenum {{param|internalformat}}, GLenum {{param|format}}, GLenum {{param|type}}, const void * {{param|data}}); | void '''glClearBufferData'''(GLenum {{param|target}}, GLenum {{param|internalformat}}, GLenum {{param|format}}, GLenum {{param|type}}, const void * {{param|data}}); | ||
{{glapi buffertargets}} | |||
; internalformat | ; internalformat | ||
: The internal format with which the data will be stored in the buffer object. | : The sized internal format with which the data will be stored in the buffer object. | ||
{{glapi pixeltransferupparams|single=}} | |||
== Description == | == Description == | ||
| Line 38: | Line 30: | ||
{{enum|GL_INVALID_ENUM}} is generated if {{param|internalformat}} is not a sized internal format. | {{enum|GL_INVALID_ENUM}} is generated if {{param|internalformat}} is not a sized internal format. | ||
{{enum|GL_INVALID_OPERATION}} is generated if any part of the buffer's data store is mapped with {{apifunc|glMapBufferRange}} or {{apifunc|glMapBuffer | {{enum|GL_INVALID_OPERATION}} is generated if any part of the buffer's data store is mapped with {{apifunc|glMapBufferRange}} or {{apifunc|glMapBuffer}}. | ||
== See Also == | == See Also == | ||
{{apifunc|glClearBufferSubData}} | {{apifunc|glBindBuffer}}, {{apifunc|glBufferData}}, {{apifunc|glInvalidateBufferData}}, {{apifunc|glClearBufferSubData}}, {{apifunc|glMapBufferRange}}, {{apifunc|glUnmapBuffer}} | ||
== Copyright == | == Copyright == | ||
| Line 50: | Line 42: | ||
[[Category:Core API Reference|ClearBufferData]] | [[Category:Core API Reference|ClearBufferData]] | ||
[[Category:Core API Ref Buffer Objects|ClearBufferData]] | [[Category:Core API Ref Buffer Objects|ClearBufferData]] | ||
[[Category:Buffer Object API State Functions|ClearBufferData]] | |||
Latest revision as of 11:27, 18 April 2020
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 4.3 | |
| Core ARB extension | ARB_clear_buffer_object | |
glClearBufferData: fill a buffer object's data store with a fixed value
Function Definition
void glClearBufferData(GLenum target, GLenum internalformat, 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.
- 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
glClearBufferData fills the entirety of a buffer object's data store with data from client memory. 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 buffer object's data store.
If data is NULL, then 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_OPERATION is generated if any part of the buffer's data store is mapped with glMapBufferRange or glMapBuffer.
See Also
glBindBuffer, glBufferData, glInvalidateBufferData, glClearBufferSubData, glMapBufferRange, glUnmapBuffer
Copyright
Copyright © 2011-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/.