Struct glin::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: 'static> SharedBuffer<T>

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

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

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: GLenum)

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

see: gl(Named)BufferData

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

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

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

Unsafe cause reading from the mutable slice is undefined behaviour

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

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

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

pub fn stride(&self) -> usize

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

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

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<T: 'static> BufferRange<T> for SharedBuffer<T>

fn start(&self) -> usize

fn end(&self) -> usize

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

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

fn start(&self) -> usize

fn end(&self) -> usize

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

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

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

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

type CastTo = SharedBuffer<T>

fn cast(self) -> SharedBuffer<T>

impl<T> Clone for SharedBuffer<T>

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> Debug for SharedBuffer<T>

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

Formats the value using the given formatter.

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

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

Performs the conversion.

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

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

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

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

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

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

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

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

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

This method tests for !=.

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

fn id(&self) -> GLuint

OpenGL id

fn len(&self) -> usize

Number of elements on the last update

fn capacity(&self) -> usize

Allocated capacity of the buffer in number of elements

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

Maps a buffer object’s data store

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

Copy one buffer into another

unsafe fn unmap(&self)

fn is_empty(&self) -> bool

fn bytes(&self) -> usize

Total bytes on the last update

fn capacity_bytes(&self) -> usize

Total capcacity of the buffer in bytes

fn stride(&self) -> usize

Stride of the buffer type

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

fn id(&self) -> GLuint

OpenGL id

fn len(&self) -> usize

Number of elements on the last update

fn capacity(&self) -> usize

Allocated capacity of the buffer in number of elements

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

Maps a buffer object’s data store

fn copy_to<U, BB: BufferRange<U> + WithBackendMut>(&self, dst: &mut BB) where
    Self: Sized, 

Copy one buffer into another

unsafe fn unmap(&self)

fn is_empty(&self) -> bool

fn bytes(&self) -> usize

Total bytes on the last update

fn capacity_bytes(&self) -> usize

Total capcacity of the buffer in bytes

fn stride(&self) -> usize

Stride of the buffer type

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

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

Maps a buffer object’s data store

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

Maps a buffer object’s data store

impl<T> WithBackend for SharedBuffer<T>

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

impl<T> WithBackendMut for SharedBuffer<T>

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

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

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

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

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

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

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

impl<T> StructuralEq for SharedBuffer<T>

impl<T> StructuralPartialEq for SharedBuffer<T>