Skip to main content

IndirectBuffer

Struct IndirectBuffer 

Source
pub struct IndirectBuffer<T: IndirectCommand> { /* private fields */ }
Expand description

A type-safe GPU buffer for indirect draw commands.

This wrapper ensures type safety and provides convenient methods for writing and using indirect draw commands.

§Type Parameters

  • T - The type of indirect command (either DrawIndirect or DrawIndexedIndirect)

§Example

use astrelis_render::{IndirectBuffer, DrawIndexedIndirect, Renderer};

// Create an indirect buffer for 100 indexed draw commands
let indirect_buffer = IndirectBuffer::<DrawIndexedIndirect>::new(
    context,
    Some("My Indirect Buffer"),
    100,
);

// Write commands
let commands = vec![
    DrawIndexedIndirect::single(36),  // Draw 36 indices
    DrawIndexedIndirect::instanced(36, 10),  // Draw 36 indices, 10 instances
];
indirect_buffer.write(&context.queue, &commands);

// In render pass
render_pass.draw_indexed_indirect(indirect_buffer.buffer(), 0);

Implementations§

Source§

impl<T: IndirectCommand> IndirectBuffer<T>

Source

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

Create a new indirect buffer with the specified capacity.

§Arguments
  • context - The graphics context
  • label - Optional debug label
  • capacity - Maximum number of commands the buffer can hold
§Panics

Panics if INDIRECT_FIRST_INSTANCE feature is not enabled on the context.

Source

pub fn new_init( context: &GraphicsContext, label: Option<&str>, commands: &[T], ) -> Self

Create a new indirect buffer initialized with commands.

§Arguments
  • context - The graphics context
  • label - Optional debug label
  • commands - Initial commands to write to the buffer
§Panics

Panics if INDIRECT_FIRST_INSTANCE feature is not enabled on the context.

Source

pub fn buffer(&self) -> &Buffer

Get the underlying wgpu buffer.

Source

pub fn capacity(&self) -> usize

Get the capacity (maximum number of commands).

Source

pub fn size_bytes(&self) -> u64

Get the size of the buffer in bytes.

Source

pub fn offset_of(&self, index: usize) -> u64

Get the byte offset of a command at the given index.

Source

pub fn write_at(&self, queue: &Queue, start_index: usize, commands: &[T])

Write commands to the buffer starting at the given index.

§Arguments
  • queue - The command queue to use for the write
  • start_index - Index of the first command to write
  • commands - Commands to write
§Panics

Panics if the write would exceed the buffer capacity.

Source

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

Write commands to the buffer starting at index 0.

§Arguments
  • queue - The command queue to use for the write
  • commands - Commands to write
§Panics

Panics if the write would exceed the buffer capacity.

Source

pub fn clear(&self, queue: &Queue)

Clear the buffer by writing zeros.

Auto Trait Implementations§

§

impl<T> Freeze for IndirectBuffer<T>

§

impl<T> !RefUnwindSafe for IndirectBuffer<T>

§

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

§

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

§

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

§

impl<T> !UnwindSafe for IndirectBuffer<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,