Skip to main content

TypedBuffer

Struct TypedBuffer 

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

A GPU buffer with type-safe element tracking.

This wrapper adds:

  • Type safety via generics
  • Automatic length tracking
  • Convenient write operations

The underlying buffer is directly accessible via the AsWgpu trait.

Implementations§

Source§

impl<T: Pod> TypedBuffer<T>

Source

pub fn new( device: &Device, label: Option<&str>, data: &[T], usage: BufferUsages, ) -> Self

Create a new typed buffer with initial data.

§Arguments
  • device - The wgpu device to create the buffer on
  • label - Optional debug label for the buffer
  • data - Initial data to populate the buffer with
  • usage - Buffer usage flags
Source

pub fn with_capacity( device: &Device, label: Option<&str>, capacity: u32, usage: BufferUsages, ) -> Self

Create an empty typed buffer with a given capacity.

§Arguments
  • device - The wgpu device to create the buffer on
  • label - Optional debug label for the buffer
  • capacity - Number of elements the buffer can hold
  • usage - Buffer usage flags
Source

pub fn len(&self) -> u32

Get the number of elements in the buffer.

Source

pub fn is_empty(&self) -> bool

Check if the buffer is empty.

Source

pub fn size(&self) -> u64

Get the size of the buffer in bytes.

Source

pub fn capacity_bytes(&self) -> u64

Get the capacity of the buffer in bytes.

Source

pub fn capacity(&self) -> u32

Get the capacity in number of elements.

Source

pub fn usage(&self) -> BufferUsages

Get the buffer usage flags.

Source

pub fn slice(&self) -> BufferSlice<'_>

Get a slice of the entire buffer.

Source

pub fn slice_range(&self, range: Range<u32>) -> BufferSlice<'_>

Get a slice of a portion of the buffer.

Source

pub fn write(&self, queue: &Queue, data: &[T])

Write data to the buffer.

The buffer must have been created with COPY_DST usage.

Source

pub fn write_at(&self, queue: &Queue, offset: u32, data: &[T])

Write data to the buffer at an offset.

The buffer must have been created with COPY_DST usage.

Source

pub fn as_binding(&self) -> BindingResource<'_>

Get the buffer as a binding resource (for bind groups).

Source

pub fn buffer(&self) -> &Buffer

Get a reference to the underlying buffer.

Source§

impl<T: Pod> TypedBuffer<T>

Source

pub fn new_uniform(device: &Device, label: Option<&str>, data: &T) -> Self

Create a new uniform buffer.

Source

pub fn write_uniform(&self, queue: &Queue, data: &T)

Write a single uniform value to the buffer.

Trait Implementations§

Source§

impl<T: Pod> AsWgpu for TypedBuffer<T>

Source§

type WgpuType = Buffer

The underlying wgpu type.
Source§

fn as_wgpu(&self) -> &Self::WgpuType

Get a reference to the underlying wgpu type.
Source§

impl<T: Pod> IntoWgpu for TypedBuffer<T>

Source§

type WgpuType = Buffer

The underlying wgpu type.
Source§

fn into_wgpu(self) -> Self::WgpuType

Consume self and return the underlying wgpu type.

Auto Trait Implementations§

§

impl<T> Freeze for TypedBuffer<T>

§

impl<T> !RefUnwindSafe for TypedBuffer<T>

§

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> !UnwindSafe for TypedBuffer<T>

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<T> for T

Source§

fn downcast(&self) -> &T

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

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