Skip to main content

DrawEntry

Struct DrawEntry 

Source
pub struct DrawEntry {
    pub pipeline: RenderPipeline,
    pub bind_groups: ArrayVec<BindGroupBinding, MAX_BIND_GROUPS>,
    pub vertex_buffers: ArrayVec<VertexBufferBinding, MAX_VERTEX_BUFFERS>,
    pub index_buffer: Option<(Buffer, Range<u64>, IndexFormat)>,
    pub scissor: Option<ScissorRect>,
    pub stencil_reference: u32,
    pub order: DrawOrder,
    pub range: DrawRange,
}
Expand description

One draw: the pipeline and every resource it binds, followed by what to draw.

A draw carries the union of the bind groups the pipeline, its material and the mesh need, at the slots they name. The renderer’s built-in pipeline expects three or four vertex buffers — position, optional joints and weights, UV and vertex color, and the per-instance model matrix and base color — but the shape is generic, so custom pipelines can bind whatever they declare.

All slots are inline: a draw never allocates, so a whole scene can be rebuilt each frame without touching the allocator.

Fields§

§pipeline: RenderPipeline

The render pipeline to bind.

§bind_groups: ArrayVec<BindGroupBinding, MAX_BIND_GROUPS>

Bind groups, bound at the slots they name. The built-in pipeline uses index 0 for the camera, frame globals and mesh metadata, index 1 for the material, and any remaining slots for mesh-level groups.

§vertex_buffers: ArrayVec<VertexBufferBinding, MAX_VERTEX_BUFFERS>

Vertex buffers, bound at the slots they name.

§index_buffer: Option<(Buffer, Range<u64>, IndexFormat)>

Index buffer, the byte range read from it and its format, when the draw is indexed.

§scissor: Option<ScissorRect>

Pixels outside this rectangle are discarded.

A draw that sets it clips in the rasterizer instead of in the geometry. None means “leave whatever the pass already has”, not “cover the whole target”: wgpu’s scissor is pass state with no reset call, so once a draw sets one it stays set for every later draw in the pass — ordering a clipped draw last is the caller’s job, which in a composite is what DrawOrder::After is for.

§stencil_reference: u32

The stencil reference value the draw tests against.

Set on every draw (defaulting to 0, the pass’s own default), so a draw that does not name one resets a value an earlier draw left behind.

§order: DrawOrder

Where the draw sits in the composite of a pass’s scenes.

Scene::record ignores it. Scene::record_composited groups its scenes’ draws by it; the default, DrawOrder::Before, keeps the draw where its scene listed it.

§range: DrawRange

What to draw.

Implementations§

Source§

impl DrawEntry

Source

pub fn new(pipeline: &RenderPipeline, range: DrawRange) -> Self

A draw of range with the given pipeline, no bind groups, no vertex buffers, no index buffer, no scissor and a zero stencil reference; fill in the fields the pipeline needs.

Source

pub fn with_bind_group(self, index: u32, bind_group: &BindGroup) -> Self

Bind bind_group at index.

Source

pub fn with_vertex_buffer(self, slot: u32, buffer: &Buffer) -> Self

Bind buffer whole at vertex-buffer slot.

Source

pub fn with_vertex_buffer_range( self, slot: u32, buffer: &Buffer, range: Range<u64>, ) -> Self

Bind range of buffer at vertex-buffer slot.

Source

pub fn with_scissor(self, scissor: ScissorRect) -> Self

Discard fragments outside scissor. It stays set for every draw after this one in the pass, so see DrawEntry::scissor.

Source

pub fn with_index_buffer(self, buffer: &Buffer, format: IndexFormat) -> Self

Bind buffer as the index buffer, reading all of it.

Source

pub fn with_order(self, order: DrawOrder) -> Self

Place the draw in the composite of a pass’s scenes; see DrawOrder.

Trait Implementations§

Source§

impl Clone for DrawEntry

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DrawEntry

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

impl<T> Upcast<T> for T

§

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

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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