Struct glin::Buffer

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

A mutable buffer object allocated with gl(Named)BufferData

Implementations

impl<T: 'static> Buffer<T>

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

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

see: gl(Named)BufferData

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

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, Self>>

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, Self>>

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, Self>>

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

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

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

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: BufferRange<U> + WithBackendMut>(&self, dst: &mut B)

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

OpenGL id

pub fn stride(&self) -> usize

Stride of the buffer type

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

Consume into a shared buffer

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

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: InputRange>(
    &mut self,
    range: R
) -> Range<T, Buffer<T>, &mut Buffer<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

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

Consumes the buffer into a range

Panics if the range is out of bounds

impl Buffer<u8>

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

Trait Implementations

impl<'a, T: 'static> BufferRange<T> for Buffer<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 &Buffer<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> BufferRangeMut<T> for Buffer<T>

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

impl<T> Cast<T> for Buffer<u8>

type CastTo = Buffer<T>

fn cast(self) -> Buffer<T>

impl<T: Debug> Debug for Buffer<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 Buffer<T>

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

impl<'a, T> MapRangeMut<T> for Buffer<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<Buffer<T>> for Buffer<T>

fn eq(&self, other: &Self) -> bool

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

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, T: 'static> TypedBuffer<T> for Buffer<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> TypedBuffer<T> for &Buffer<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 Buffer<T>

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

Maps a buffer object’s data store

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

Maps a buffer object’s data store

impl<'a, T> WithBackend for Buffer<T>

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

impl<'a, T> WithBackendMut for Buffer<T>

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

impl<'a, T: 'static> WithMapRange<T> for Buffer<T>

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

impl<'a, T: 'static> WithMapRangeMut<T> for Buffer<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 for Buffer<T>