Wizt::RenderBasin::Buffer Class Reference

Encapsulation of buffer objects. More...

#include <ocean/Anemonia/RenderBasin.hpp>

Inheritance diagram for Wizt::RenderBasin::Buffer:

Classes
struct	StorageFlags
	Encapsulation of https://registry.khronos.org/OpenGL-Refpages/gl4/html/glBufferStorage.xhtml. More...

Detailed Description

Encapsulation of buffer objects.

---

Class Documentation

Wizt::RenderBasin::Buffer::StorageFlags

struct Wizt::RenderBasin::Buffer::StorageFlags

Encapsulation of https://registry.khronos.org/OpenGL-Refpages/gl4/html/glBufferStorage.xhtml.

Class Members
unsigned	client_storage_bit: 1	When all other criteria for the buffer storage allocation are met, this bit may be used by an implementation to determine whether to use storage that is local to the server or to the client to serve as the backing store for the buffer.
unsigned	dynamic_storage_bit: 1	The contents of the data store may be updated after creation through calls to glBufferSubData. If this bit is not set, the buffer content may not be directly updated by the client. The data argument may be used to specify the initial content of the buffer's data store regardless of the presence of the GL_DYNAMIC_STORAGE_BIT. Regardless of the presence of this bit, buffers may always be updated with server-side calls such as glCopyBufferSubData and glClearBufferSubData.
unsigned	map_coherent_bit: 1	Shared access to buffers that are simultaneously mapped for client access and are used by the server will be coherent, so long as that mapping is performed using glMapBufferRange. That is, data written to the store by either the client or server will be immediately visible to the other with no further action taken by the application. In particular, If MAP_COHERENT_BIT is not set and the client performs a write followed by a call to the glMemoryBarrier command with the GL_CLIENT_MAPPED_BUFFER_BARRIER_BIT set, then in subsequent commands the server will see the writes. If MAP_COHERENT_BIT is set and the client performs a write, then in subsequent commands the server will see the writes. If MAP_COHERENT_BIT is not set and the server performs a write, the application must call glMemoryBarrier with the GL_CLIENT_MAPPED_BUFFER_BARRIER_BIT set and then call glFenceSync with GL_SYNC_GPU_COMMANDS_COMPLETE (or glFinish). Then the CPU will see the writes after the sync is complete. If MAP_COHERENT_BIT is set and the server does a write, the app must call glFenceSync with GL_SYNC_GPU_COMMANDS_COMPLETE (or glFinish). Then the CPU will see the writes after the sync is complete.
unsigned	map_flush_explicit_bit: 1	Indicates that one or more discrete subranges of the mapping may be modified. When this flag is set, modifications to each subrange must be explicitly flushed by calling glFlushMappedBufferRange. No GL error is set if a subrange of the mapping is modified and not flushed, but data within the corresponding subrange of the buffer are undefined. This flag may only be used in conjunction with GL_MAP_WRITE_BIT. When this option is selected, flushing is strictly limited to regions that are explicitly indicated with calls to glFlushMappedBufferRange prior to unmap; if this option is not selected glUnmapBuffer will automatically flush the entire mapped range when called.
unsigned	map_invalidate_buffer_bit: 1	Indicates that the previous contents of the entire buffer may be discarded. Data within the entire buffer are undefined with the exception of subsequently written data. No GL error is generated if subsequent GL operations access unwritten data, but the result is undefined and system errors (possibly including program termination) may occur. This flag may not be used in combination with GL_MAP_READ_BIT.
unsigned	map_invalidate_range_bit: 1	Indicates that the previous contents of the specified range may be discarded. Data within this range are undefined with the exception of subsequently written data. No GL error is generated if subsequent GL operations access unwritten data, but the result is undefined and system errors (possibly including program termination) may occur. This flag may not be used in combination with GL_MAP_READ_BIT.
unsigned	map_persistent_bit: 1
unsigned	map_read_bit: 1	The data store may be mapped by the client for read access and a pointer in the client's address space obtained that may be read from.
unsigned	map_unsynchronized_bit: 1	Indicates that the GL should not attempt to synchronize pending operations on the buffer prior to returning from glMapBufferRange or glMapNamedBufferRange. No GL error is generated if pending operations which source or modify the buffer overlap the mapped region, but the result of such previous and any subsequent operations is undefined.
unsigned	map_write_bit: 1	The data store may be mapped by the client for write access and a pointer in the client's address space obtained that may be written through.