Struct Buffer

pub struct Buffer<T>
where
    T: Content + ?Sized,
{ /* private fields */ }

Represents a view of a buffer.

Implementations

impl<T> Buffer<T>

where T: Content + ?Sized,

pub fn new<F>( facade: &F, data: &T, ty: BufferType, mode: BufferMode, ) -> Result<Buffer<T>, BufferCreationError>

where F: Facade + ?Sized,

Builds a new buffer containing the given data. The size of the buffer is equal to the size of the data.

pub fn empty_unsized<F>( facade: &F, ty: BufferType, size: usize, mode: BufferMode, ) -> Result<Buffer<T>, BufferCreationError>

where F: Facade + ?Sized,

Builds a new buffer of the given size.

pub fn get_context(&self) -> &Rc<Context>

Returns the context corresponding to this buffer.

pub fn get_size(&self) -> usize

Returns the size in bytes of this buffer.

pub fn is_persistent(&self) -> bool

Returns true if this buffer uses persistent mapping.

pub fn write(&self, data: &T)

Uploads some data in this buffer.

Implementation

• For persistent-mapped buffers, waits untils the data is no longer used by the GPU then memcpies the data to the mapping.
• For immutable buffers, creates a temporary buffer that contains the data then calls glCopyBufferSubData to copy from the temporary buffer to the real one.
• For other types, calls glBufferSubData.

Panic

Panics if the length of data is different from the length of this buffer.

pub fn invalidate(&self)

Invalidates the content of the buffer. The data becomes undefined.

You should call this if you only use parts of a buffer. For example if you want to use the first half of the buffer, you invalidate the whole buffer then write the first half.

This operation is a no-op if the backend doesn’t support it and for persistent-mapped buffers.

Implementation

Calls glInvalidateBufferData if supported. Otherwise, calls glBufferData with a null pointer for data. If glBufferStorage has been used to create the buffer and glInvalidateBufferData is not supported, does nothing.

pub fn read(&self) -> Result<<T as Content>::Owned, ReadError>

Reads the content of the buffer.

pub fn map(&mut self) -> Mapping<'_, T>

Maps the buffer in memory for both reading and writing.

Implementation

• For persistent-mapped buffers, waits until the data is no longer accessed by the GPU then returns a pointer to the existing mapping.
• For immutable buffers, creates a temporary buffer containing the data of the buffer and maps it. When the mapping object is destroyed, copies the content of the temporary buffer to the real buffer.
• For other types, calls glMapBuffer or glMapSubBuffer.

pub fn map_read(&mut self) -> ReadMapping<'_, T>

Maps the buffer in memory for reading.

Implementation

• For persistent-mapped buffers, waits until the data is no longer accessed by the GPU then returns a pointer to the existing mapping.
• For immutable buffers, creates a temporary buffer containing the data of the buffer and maps it.
• For other types, calls glMapBuffer or glMapSubBuffer.

pub fn map_write(&mut self) -> WriteMapping<'_, T>

Maps the buffer in memory for writing only.

Implementation

• For persistent-mapped buffers, waits until the data is no longer accessed by the GPU then returns a pointer to the existing mapping.
• For immutable buffers, creates a temporary buffer and maps it. When the mapping object is destroyed, copies the content of the temporary buffer to the real buffer.
• For other types, calls glMapBuffer or glMapSubBuffer.

pub fn copy_to<'a, S>(&self, target: S) -> Result<(), CopyError>

where S: Into<BufferSlice<'a, T>>, T: 'a,

Copies the content of the buffer to another buffer.

Panic

Panics if T is unsized and the other buffer is too small.

pub unsafe fn slice_custom<F, R>(&self, f: F) -> BufferSlice<'_, R>

where F: for<'r> FnOnce(&'r T) -> &'r R, R: Content + ?Sized,

Builds a slice that contains an element from inside the buffer.

This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.

Example

#[derive(Copy, Clone)]
struct BufferContent {
    value1: u16,
    value2: u16,
}
let slice = unsafe { buffer.slice_custom(|content| &content.value2) };

Safety

The object whose reference is passed to the closure is uninitialized. Therefore you must not access the content of the object.

You must return a reference to an element from the parameter. The closure must not panic.

pub unsafe fn slice_custom_mut<F, R>(&mut self, f: F) -> BufferMutSlice<'_, R>

where F: for<'r> FnOnce(&'r T) -> &'r R, R: Content + ?Sized,

Same as slice_custom but returns a mutable slice.

This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.

pub fn as_slice(&self) -> BufferSlice<'_, T>

Builds a slice containing the whole subbuffer.

This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.

pub fn as_mut_slice(&mut self) -> BufferMutSlice<'_, T>

Builds a slice containing the whole subbuffer.

This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.

pub fn as_slice_any(&self) -> BufferAnySlice<'_>

Builds a slice-any containing the whole subbuffer.

This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.

impl<T> Buffer<T>

where T: Content + Copy,

pub fn empty<F>( facade: &F, ty: BufferType, mode: BufferMode, ) -> Result<Buffer<T>, BufferCreationError>

where F: Facade + ?Sized,

Builds a new buffer of the given size.

impl<T> Buffer<[T]>

where [T]: Content, T: Copy,

pub fn empty_array<F>( facade: &F, ty: BufferType, len: usize, mode: BufferMode, ) -> Result<Buffer<[T]>, BufferCreationError>

where F: Facade + ?Sized,

Builds a new buffer of the given size.

pub fn len(&self) -> usize

Returns the number of elements in this buffer.

pub fn slice<R>(&self, range: R) -> Option<BufferSlice<'_, [T]>>

where R: RangeArgument<usize>,

Builds a slice of this subbuffer. Returns None if out of range.

This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.

pub fn slice_mut<R>(&mut self, range: R) -> Option<BufferMutSlice<'_, [T]>>

where R: RangeArgument<usize>,

Builds a slice of this subbuffer. Returns None if out of range.

This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.

impl<T> Buffer<[T]>

where T: PixelValue,

pub fn read_as_texture_1d<S>(&self) -> Result<S, ReadError>

where S: Texture1dDataSink<T>,

Reads the content of the buffer.

Trait Implementations

impl<'a, T> AsUniformValue for &'a Buffer<T>

where T: UniformBlock + Content + ?Sized,

fn as_uniform_value(&self) -> UniformValue<'_>

Builds a UniformValue.

impl<T> Debug for Buffer<T>

where T: Content + ?Sized,

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

Formats the value using the given formatter.

impl<T> Drop for Buffer<T>

where T: Content + ?Sized,

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> From<&'a Buffer<T>> for BufferSlice<'a, T>

where T: Content + 'a + ?Sized,

fn from(b: &'a Buffer<T>) -> BufferSlice<'a, T>

Converts to this type from the input type.

impl<'a, T> From<&'a mut Buffer<T>> for BufferMutSlice<'a, T>

where T: Content + 'a + ?Sized,

fn from(b: &'a mut Buffer<T>) -> BufferMutSlice<'a, T>

Converts to this type from the input type.

impl<'a, T> From<&'a mut Buffer<T>> for BufferSlice<'a, T>

where T: Content + 'a + ?Sized,

fn from(b: &'a mut Buffer<T>) -> BufferSlice<'a, T>

Converts to this type from the input type.

impl<T> From<Buffer<[T]>> for VertexBuffer<T>

where T: Vertex + Copy,

fn from(buffer: Buffer<[T]>) -> VertexBuffer<T>

Converts to this type from the input type.

impl<T> From<Buffer<[T]>> for VertexBufferAny

where T: Vertex + Copy + Send + 'static,

fn from(buf: Buffer<[T]>) -> VertexBufferAny

Converts to this type from the input type.

impl<T> From<Buffer<T>> for BufferAny

where T: Content + Send + 'static + ?Sized,

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

Converts to this type from the input type.

impl<T> GlObject for Buffer<T>

where T: Content + ?Sized,

type Id = u32

The type of identifier for this object.

fn get_id(&self) -> u32

Returns the id of the object.