Struct luminance::buffer::Buffer

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

A Buffer is a GPU region you can picture as an array.

You’re strongly advised to use either Buffer::from_slice or Buffer::repeat to create a Buffer. The Buffer::new should only be used if you know what you’re doing.

Methods

impl<T> Buffer<T>

pub unsafe fn new<C>(ctx: &mut C, len: usize) -> Buffer<T> where
    C: GraphicsContext, 

Create a new Buffer with a given number of elements.

That function leaves the buffer uninitialized, which is unsafe. If you prefer not to use any unsafe function, feel free to use Buffer::from_slice or Buffer::repeat instead.

pub fn from_slice<C, S>(ctx: &mut C, slice: S) -> Buffer<T> where
    C: GraphicsContext,
    S: AsRef<[T]>, 

Create a buffer out of a slice.

pub fn repeat<C>(ctx: &mut C, len: usize, value: T) -> Self where
    C: GraphicsContext,
    T: Copy, 

Create a new Buffer with a given number of elements and ininitialize all the elements to the same value.

pub fn at(&self, i: usize) -> Option<T> where
    T: Copy, 

Retrieve an element from the Buffer.

This version checks boundaries.

pub fn whole(&self) -> Vec<T> where
    T: Copy, 

Retrieve the whole content of the Buffer.

pub fn set(&mut self, i: usize, x: T) -> Result<(), BufferError> where
    T: Copy, 

Set a value at a given index in the Buffer.

This version checks boundaries.

pub fn write_whole(&mut self, values: &[T]) -> Result<(), BufferError>

Write a whole slice into a buffer.

If the slice you pass in has less items than the length of the buffer, you’ll get a BufferError::TooFewValues error. If it has more, you’ll get BufferError::TooManyValues.

This function won’t write anything on any error.

pub fn clear(&mut self, x: T) -> Result<(), BufferError> where
    T: Copy, 

Fill the Buffer with a single value.

pub fn fill<V>(&mut self, values: V) -> Result<(), BufferError> where
    V: AsRef<[T]>, 

Fill the whole buffer with an array.

pub fn to_raw(self) -> RawBuffer

Convert a buffer to its raw representation.

Becareful: once you have called this function, it is not possible to go back to a Buffer.

pub fn as_slice(&mut self) -> Result<BufferSlice<T>, BufferError>

Obtain an immutable slice view into the buffer.

pub fn as_slice_mut(&mut self) -> Result<BufferSliceMut<T>, BufferError>

Obtain a mutable slice view into the buffer.

Methods from Deref<Target = RawBuffer>

pub fn len(&self) -> usize

Get the length of the buffer.

Trait Implementations

impl<T> From<Buffer<T>> for RawBuffer

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

Performs the conversion.

impl<T> DerefMut for Buffer<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Deref for Buffer<T>

type Target = RawBuffer

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.