Skip to main content

TypedBuffer

Struct TypedBuffer 

Source
pub struct TypedBuffer<T: Copy> { /* private fields */ }
Expand description

A strongly-typed GPU Shader Storage Buffer Object.

T must be Copy so that we can safely transmute slices to byte slices for upload/download. In a real engine, T would also be bytemuck::Pod.

This buffer holds the GL name, current element count, capacity, usage hint, and a reference to the shared memory tracker.

Implementations§

Source§

impl<T: Copy> TypedBuffer<T>

Source

pub fn create( gl: &Context, capacity: usize, usage: BufferUsage, binding_index: u32, tracker: Arc<MemoryTracker>, ) -> Self

Create a new typed buffer with given capacity (number of T elements).

The gl parameter is the glow context. binding_index is the SSBO binding point. The buffer is allocated but not filled.

Source

pub fn upload(&mut self, gl: &Context, data: &[T])

Upload a slice of data into the buffer starting at element offset 0. The buffer is resized if necessary.

Source

pub fn upload_range(&mut self, gl: &Context, offset: usize, data: &[T])

Upload data at a specific element offset (partial update).

Source

pub fn download(&self, gl: &Context) -> Vec<T>

Download the entire buffer contents back to the CPU.

Source

pub fn download_range( &self, gl: &Context, offset: usize, count: usize, ) -> Vec<T>

Download a sub-range [offset..offset+count) of elements.

Source

pub fn resize(&mut self, gl: &Context, new_capacity: usize)

Resize the buffer to a new capacity. Existing data is lost.

Source

pub fn resize_preserve(&mut self, gl: &Context, new_capacity: usize)

Resize the buffer, preserving existing data up to min(old_len, new_capacity).

Source

pub fn bind(&self, gl: &Context)

Bind this buffer to its SSBO binding index.

Source

pub fn unbind(&self, gl: &Context)

Unbind SSBO at this buffer’s binding index.

Source

pub fn barrier(&self, gl: &Context, barrier_type: BufferBarrierType)

Issue a memory barrier for this buffer.

Source

pub fn clear(&mut self, gl: &Context)

Clear the buffer contents to zero.

Source

pub fn destroy(self, gl: &Context)

Delete the underlying GL buffer.

Source

pub fn len(&self) -> usize

Number of elements currently stored.

Source

pub fn is_empty(&self) -> bool

Whether the buffer is empty.

Source

pub fn capacity(&self) -> usize

Current capacity in number of elements.

Source

pub fn byte_size(&self) -> usize

Size in bytes currently allocated.

Source

pub fn handle(&self) -> BufferHandle

Raw buffer handle.

Source

pub fn binding(&self) -> u32

SSBO binding index.

Auto Trait Implementations§

§

impl<T> Freeze for TypedBuffer<T>

§

impl<T> RefUnwindSafe for TypedBuffer<T>
where T: RefUnwindSafe,

§

impl<T> Send for TypedBuffer<T>
where T: Send,

§

impl<T> Sync for TypedBuffer<T>
where T: Sync,

§

impl<T> Unpin for TypedBuffer<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for TypedBuffer<T>

§

impl<T> UnwindSafe for TypedBuffer<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,