Skip to main content

InstanceBuffer

Struct InstanceBuffer 

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

GPU instance buffer with partial update support.

Maintains a CPU-side buffer and GPU buffer, tracking which ranges have been modified and need uploading. Supports efficient partial writes for retained-mode rendering where only dirty instances change.

Implementations§

Source§

impl<T: Pod> InstanceBuffer<T>

Source

pub fn new(device: &Device, label: Option<&str>, capacity: usize) -> Self

Create a new instance buffer with the specified capacity.

Source

pub fn buffer(&self) -> &Buffer

Get the GPU buffer.

Source

pub fn instances(&self) -> &[T]

Get the current instance data.

Source

pub fn len(&self) -> usize

Get the number of instances.

Source

pub fn is_empty(&self) -> bool

Check if the buffer is empty.

Source

pub fn capacity(&self) -> usize

Get the capacity.

Source

pub fn clear(&mut self)

Clear all instances.

Source

pub fn set_instances(&mut self, device: &Device, instances: Vec<T>)

Set instances, replacing all existing data.

Marks the entire buffer as dirty for GPU upload. Reallocates GPU buffer if capacity is exceeded.

Source

pub fn update_range(&mut self, start: usize, new_data: &[T])

Update a specific range of instances.

Replaces instances[start..end] with the provided data. Marks the range as dirty for GPU upload.

Source

pub fn update_instance(&mut self, index: usize, instance: T)

Update a single instance.

Source

pub fn append(&mut self, device: &Device, new_instances: &[T])

Append instances to the buffer.

Reallocates if capacity is exceeded.

Source

pub fn upload_dirty(&mut self, queue: &Queue)

Upload all dirty ranges to the GPU.

This performs partial buffer writes for each dirty range, minimizing GPU bandwidth usage for retained rendering.

Source

pub fn upload_all(&mut self, queue: &Queue)

Force upload of the entire buffer, ignoring dirty tracking.

Source

pub fn dirty_ranges(&self) -> &DirtyRanges

Get dirty ranges for inspection.

Source

pub fn write_count(&self) -> u64

Get write statistics.

Source

pub fn stats(&self) -> InstanceBufferStats

Get buffer statistics.

Auto Trait Implementations§

§

impl<T> Freeze for InstanceBuffer<T>

§

impl<T> !RefUnwindSafe for InstanceBuffer<T>

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for InstanceBuffer<T>

§

impl<T> !UnwindSafe for InstanceBuffer<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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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,