Struct rin::gl::SharedBuffer

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

Wrapper around a Buffer with internal reference counting

Useful for example when the same buffer or ranges of the same buffer are to be used in different VAOs

Implementations

impl<T> SharedBuffer<T> where
    T: 'static, 

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

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])

pub fn with_map_read<F>(&self, flags: MapReadFlags, f: F) -> Result<(), Error> where
    F: FnMut(&[T]), 

pub unsafe fn map_write<F>(
    &mut self,
    flags: MapWriteFlags,
    f: F
) -> Result<(), Error> where
    F: FnMut(&mut [T]), 

Unsafe cause reading from the mutable slice is undefined behaviour

pub fn map_read_write<F>(
    &mut self,
    flags: MapReadWriteFlags,
    f: F
) -> Result<(), Error> where
    F: FnMut(&mut [T]), 

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

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> usize

pub fn bytes(&self) -> usize

pub fn capacity_bytes(&self) -> usize

pub fn id(&self) -> u32

pub fn stride(&self) -> usize

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

pub fn range_mut<R>(
    &mut self,
    range: R
) -> Range<T, SharedBuffer<T>, SharedBuffer<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

impl SharedBuffer<u8>

pub fn cast<T>(self) -> SharedBuffer<T>

Trait Implementations

impl<'a, '_, T> BufferRange<T> for &'_ SharedBuffer<T> where
    T: 'static, 

pub fn start(&self) -> usize

pub fn end(&self) -> usize

pub fn into_range<R>(
    self,
    range: R
) -> Range<T, &'_ SharedBuffer<T>, &'_ SharedBuffer<T>> where
    R: InputRange,
    &'_ SharedBuffer<T>: Sized, 

impl<T> BufferRange<T> for SharedBuffer<T> where
    T: 'static, 

pub fn start(&self) -> usize

pub fn end(&self) -> usize

pub fn into_range<R>(
    self,
    range: R
) -> Range<T, SharedBuffer<T>, SharedBuffer<T>> where
    R: InputRange,
    SharedBuffer<T>: Sized, 

impl<T> BufferRangeMut<T> for SharedBuffer<T> where
    T: 'static, 

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

impl<T> Cast<T> for SharedBuffer<u8> where
    T: 'static, 

type CastTo = SharedBuffer<T>

pub fn cast(self) -> SharedBuffer<T>

impl<T> Clone for SharedBuffer<T>

pub fn clone(&self) -> SharedBuffer<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for SharedBuffer<T> where
    T: Debug, 

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> From<Buffer<T>> for SharedBuffer<T> where
    T: 'static, 

pub fn from(buffer: Buffer<T>) -> SharedBuffer<T>

Performs the conversion.

impl InternalCreation<SharedBuffer<u8>> for Allocator<SharedBuffer<u8>>

pub fn create<C>(
    gl: &C,
    initial_size: usize,
    flags: u32,
    target: u32
) -> Result<SharedBuffer<u8>, Error> where
    C: CreationContext, 

impl<'a, T> MapRange<T> for SharedBuffer<T>

pub fn map_range_read(
    &mut self,
    offset: usize,
    length: usize,
    flags: MapReadFlags
) -> Result<MapRead<'_, T, SharedBuffer<T>>, Error>

impl<'a, T> MapRangeMut<T> for SharedBuffer<T>

pub fn map_range_write(
    &mut self,
    offset: usize,
    length: usize,
    flags: MapWriteFlags
) -> Result<MapWrite<'_, T, SharedBuffer<T>>, Error>

pub fn map_range_read_write(
    &mut self,
    offset: usize,
    length: usize,
    flags: MapReadWriteFlags
) -> Result<MapReadWrite<'_, T, SharedBuffer<T>>, Error>

impl<T> PartialEq<SharedBuffer<T>> for SharedBuffer<T> where
    T: PartialEq<T>, 

pub fn eq(&self, other: &SharedBuffer<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &SharedBuffer<T>) -> bool

This method tests for !=.

impl<'a, '_, T> TypedBuffer<T> for &'_ SharedBuffer<T> where
    T: 'static, 

pub fn id(&self) -> u32

OpenGL id

pub fn len(&self) -> usize

Number of elements on the last update

pub fn capacity(&self) -> usize

Allocated capacity of the buffer in number of elements

pub fn with_map_read<F>(&self, flags: MapReadFlags, f: F) -> Result<(), Error> where
    F: FnMut(&[T]), 

Maps a buffer object’s data store

pub fn copy_to<U, BB>(&self, dst: &mut BB) where
    BB: BufferRange<U> + WithBackendMut,
    &'_ SharedBuffer<T>: Sized, 

Copy one buffer into another

pub unsafe fn unmap(&self)

pub fn is_empty(&self) -> bool

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 stride(&self) -> usize

Stride of the buffer type

impl<T> TypedBuffer<T> for SharedBuffer<T> where
    T: 'static, 

pub fn id(&self) -> u32

OpenGL id

pub fn len(&self) -> usize

Number of elements on the last update

pub fn capacity(&self) -> usize

Allocated capacity of the buffer in number of elements

pub fn with_map_read<F>(&self, flags: MapReadFlags, f: F) -> Result<(), Error> where
    F: FnMut(&[T]), 

Maps a buffer object’s data store

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

Copy one buffer into another

pub unsafe fn unmap(&self)

pub fn is_empty(&self) -> bool

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 stride(&self) -> usize

Stride of the buffer type

impl<'a, T> TypedBufferMut<T> for SharedBuffer<T> where
    T: 'static, 

pub unsafe fn with_map_write<F>(
    &mut self,
    flags: MapWriteFlags,
    f: F
) -> Result<(), Error> where
    F: FnMut(&mut [T]), 

Maps a buffer object’s data store

pub fn with_map_read_write<F>(
    &mut self,
    flags: MapReadWriteFlags,
    f: F
) -> Result<(), Error> where
    F: FnMut(&mut [T]), 

Maps a buffer object’s data store

impl<T> WithBackend for SharedBuffer<T>

pub fn with_backend<F, R>(&self, f: F) -> R where
    F: FnMut(&dyn Backend) -> R, 

impl<T> WithBackendMut for SharedBuffer<T>

pub fn with_backend_mut<F, R>(&mut self, f: F) -> R where
    F: FnMut(&mut dyn Backend) -> R, 

impl<T> WithMapRange<T> for SharedBuffer<T>

pub fn with_map_range_read<F>(
    &self,
    offset: usize,
    length: usize,
    flags: MapReadFlags,
    f: F
) -> Result<(), Error> where
    F: FnMut(&[T]), 

impl<T> WithMapRangeMut<T> for SharedBuffer<T>

pub unsafe fn with_map_range_write<F>(
    &mut self,
    offset: usize,
    length: usize,
    flags: MapWriteFlags,
    f: F
) -> Result<(), Error> where
    F: FnMut(&mut [T]), 

pub fn with_map_range_read_write<F>(
    &mut self,
    offset: usize,
    length: usize,
    flags: MapReadWriteFlags,
    f: F
) -> Result<(), Error> where
    F: FnMut(&mut [T]), 

impl<T> BufferExt<T> for SharedBuffer<T> where
    T: 'static, 

impl<T> Eq for SharedBuffer<T> where
    T: Eq, 

impl<T> StructuralEq for SharedBuffer<T>

impl<T> StructuralPartialEq for SharedBuffer<T>