Struct luminance::buffer::Buffer

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

A Buffer is a GPU region you can picture as an array. It has a static size and cannot be resized. The size is expressed in number of elements lying in the buffer, not in bytes.

Methods

impl<T> Buffer<T>

fn new(len: usize) -> Buffer<T>

Create a new Buffer with a given number of elements.

fn len(&self) -> usize

Get the length of the buffer.

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

Retrieve an element from the Buffer.

Checks boundaries.

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

Retrieve the whole content of the Buffer.

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

Set a value at a given index in the Buffer.

Checks boundaries.

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

Write a whole slice into a buffer.

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

In all cases, the copy will be performed and clamped to reasonable length.

fn clear(&self, x: T) where
    T: Copy, 

Fill the Buffer with a single value.

fn fill(&self, values: &[T])

Fill the whole buffer with an array.

fn to_raw(self) -> RawBuffer

Convert a buffer to its raw representation.

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

Obtain an immutable slice view into the buffer.

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

Obtain a mutable slice view into the buffer.

Methods from Deref<Target = RawBuffer>

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

Obtain an immutable slice view into the buffer.

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

Obtain a mutable slice view into the buffer.

Trait Implementations

impl<T: Debug> Debug for Buffer<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Eq> Eq for Buffer<T>

impl<T: PartialEq> PartialEq for Buffer<T>

fn eq(&self, __arg_0: &Buffer<T>) -> bool

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

fn ne(&self, __arg_0: &Buffer<T>) -> bool

This method tests for !=.

impl<T> Deref for Buffer<T>

type Target = RawBuffer

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Buffer<T>

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

Mutably dereferences the value.

impl<T> Drop for Buffer<T>

fn drop(&mut self)

Executes the destructor for this type.