Struct rin::gl::buffer::BufferStorage[−][src]

pub struct BufferStorage<T> { /* fields omitted */ }

Inmmutable buffer object allocated with gl(Named)BufferStorage

Inmmutability here refers to the same concept OpenGL understands by it. The data in the buffer can still be modified but it can’t be reallocated

Implementations

`impl<T> BufferStorage<T> where T: 'static,` [src]

`pub fn update(&mut self, data: &[T])`[src]

Loads the passed data at the beginning of the buffer

Will panic if the buffer is not big enough or not allocated at all

see: gl(Named)BufferSubData

`pub fn map_read( &mut self, flags: MapReadFlags ) -> Result<MapRead<'_, T, BufferStorage<T>>, Error>`[src]

Maps a buffer object’s data store

Pass a closure that receives the mapped buffer to access it

see glMapBuffer

`pub fn map_write( &mut self, flags: MapWriteFlags ) -> Result<MapWrite<'_, T, BufferStorage<T>>, Error>`[src]

Maps a buffer object’s data store

Pass a closure that receives the mapped buffer to access it

see glMapBuffer

`pub fn map_read_write( &mut self, flags: MapReadWriteFlags ) -> Result<MapReadWrite<'_, T, BufferStorage<T>>, Error>`[src]

Maps a buffer object’s data store

Pass a closure that receives the mapped buffer to access it

see glMapBuffer

`pub unsafe fn map_read_slice( &mut self, flags: MapReadFlags ) -> Result<&[T], Error>`[src]

Maps a buffer object’s data store as a slice

This operation is unsafe cause the buffer needs to be unmapped manually so it could be accessed while mapped which is undefined behaviour

see glMapBuffer

`pub unsafe fn map_write_slice( &mut self, flags: MapWriteFlags ) -> Result<&mut [T], Error>`[src]

Maps a buffer object’s data store as a slice

This operation is unsafe cause the buffer needs to be unmapped manually so it could be accessed while mapped which is undefined behaviour

see glMapBuffer

`pub unsafe fn map_read_write_slice( &mut self, flags: MapReadWriteFlags ) -> Result<&mut [T], Error>`[src]

Maps a buffer object’s data store as a slice

This operation is unsafe cause the buffer needs to be unmapped manually so it could be accessed while mapped which is undefined behaviour

see glMapBuffer

`pub unsafe fn unmap(&mut self)`[src]

`pub fn is_persistant(&self) -> bool`[src]

On creation the storage was passed the GL_MAP_PERSISTENT_BIT

The client may request that the server read from or write to the buffer while it is mapped. The client’s pointer to the data store remains valid so long as the data store is mapped, even during execution of drawing or dispatch commands.

If the storage is not persistent, calls to persistent_map_* will fail

`pub fn is_read_map(&self) -> bool`[src]

On creation the storage was passed the GL_MAP_READ_BIT

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.

If the storage is not read map, calls to any read map will fail

`pub fn is_write_map(&self) -> bool`[src]

On creation the storage was passed the GL_MAP_WRITE_BIT

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.

If the storage is not read write, calls to any write map will fail

`pub fn is_dynamic_storage(&self) -> bool`[src]

On creation the storage was passed the GL_DYNAMIC_STORAGE_BIT

The contents of the data store may be updated after creation through calls to update (glSubBufferData). 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 copy (glCopyBufferSubData) and clear (glClearBufferSubData).

`pub fn is_coherent(&self) -> bool`[src]

On creation the storage was passed the gL_MAP_COHERENT_BIT

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 GL_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 GL_MAP_COHERENT_BIT is set and the client performs a write, then in subsequent commands the server will see the writes.
If GL_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 GL_MAP_COHERENT_BIT is set and the server does a write, the app must call FenceSync with GL_SYNC_GPU_COMMANDS_COMPLETE (or glFinish). Then the CPU will see the writes after the sync is complete.

`pub fn map_persistent_read( &self, flags: MapReadFlags ) -> Result<MapPersistentRead<T, &BufferStorage<T>>, Error>`[src]

Persistently maps a buffer object’s data store

If the storage wasn’t created as pesistent this call will fail.

Persistent maps can be send and shared with other threads but need to be dropped from the same thread they were created from. The destructor will panic otherwise.

A common pattern to do this is to return the map as the return value of a thread and receive it by explicitly joining the thread using it’s join handle from the original thread.