Struct rin::scene::renderer::resources::LightingUBO

pub struct LightingUBO {
    pub ubo: Buffer<u8>,
    pub dirty: bool,
}

Fields

ubo: Buffer<u8>

dirty: bool

Methods from Deref<Target = Buffer<u8>>

pub fn load(&mut self, data: &[T], usage: u32)

Loads the passed data into the buffer (re)allocating it

see: gl(Named)BufferData

pub fn load_target(&mut self, data: &[T], usage: u32, target: u32)

Loads the passed data into the buffer (re)allocating it to an specific target

see: gl(Named)BufferData

pub fn reserve(&mut self, len: usize, usage: u32)

Reserves len amount of memory into the buffer (re)allocating it

see: gl(Named)BufferData

pub fn reserve_target(&mut self, len: usize, usage: u32, target: u32)

Reserves len amount of memory into the buffer (re)allocating it to an specific target

see: gl(Named)BufferData

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

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, Buffer<T>>, Error>

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, Buffer<T>>, Error>

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, Buffer<T>>, Error>

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(&self, flags: MapReadFlags) -> Result<&[T], Error>

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>

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>

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)

pub fn copy_to<U, B>(&self, dst: &mut B) where
    B: BufferRange<U> + WithBackendMut, 

Copy one buffer into another

pub fn len(&self) -> usize

Number of elements on the last update

pub fn is_empty(&self) -> bool

If there’s no elements loaded in the buffer

This is len == 0 not capacity == 0

pub fn capacity(&self) -> usize

Allocated capacity of the buffer in number of elements

pub fn bytes(&self) -> usize

Total bytes on the last update

pub fn capacity_bytes(&self) -> usize

Total capcacity of the buffer in bytes

pub fn id(&self) -> u32

OpenGL id

pub fn stride(&self) -> usize

Stride of the buffer type

pub fn range<R>(&self, range: R) -> Range<T, Buffer<T>, &Buffer<T>> where
    R: InputRange, 

Get a range from the buffer

Useful to do operations on portions of the buffer

Panics if the range is out of bounds

pub fn range_mut<R>(&mut self, range: R) -> Range<T, Buffer<T>, &mut Buffer<T>> where
    R: InputRange, 

Get a mutable range from the buffer

Useful to do operations on portions of the buffer

Panics if the range is out of bounds

Trait Implementations

impl Deref for LightingUBO

type Target = Buffer<u8>

The resulting type after dereferencing.

pub fn deref(&self) -> &Buffer<u8>

Dereferences the value.

impl DerefMut for LightingUBO

pub fn deref_mut(&mut self) -> &mut Buffer<u8>

Mutably dereferences the value.