Skip to main content

RenderPipelineDesc

Struct RenderPipelineDesc 

Source
pub struct RenderPipelineDesc {
    pub label: Option<String>,
    pub layout: Option<PipelineLayout>,
    pub vertex: VertexStateDesc,
    pub primitive: PrimitiveState,
    pub depth_stencil: Option<DepthStencilState>,
    pub multisample: MultisampleState,
    pub fragment: Option<FragmentStateDesc>,
    pub multiview_mask: Option<NonZeroU32>,
    pub cache: Option<PipelineCache>,
}
Expand description

An owned mirror of wgpu’s render-pipeline descriptor, with every borrowed slice owned so it can outlive the descriptor it was read from.

A specializer rewrites these fields in place, and a SpecializedPipeline stores the result alongside the pipeline it compiles into.

Fields§

§label: Option<String>

Debug label of the pipeline.

§layout: Option<PipelineLayout>

The bind group layouts this pipeline uses.

§vertex: VertexStateDesc

The vertex stage.

§primitive: PrimitiveState

Primitive assembly and rasterization state.

§depth_stencil: Option<DepthStencilState>

Depth-stencil state, if the pass has a depth attachment.

§multisample: MultisampleState

Multisampling state.

§fragment: Option<FragmentStateDesc>

The fragment stage, if the pipeline writes color.

§multiview_mask: Option<NonZeroU32>

The multiview mask, if the pipeline renders with multiview.

§cache: Option<PipelineCache>

The pipeline cache to compile against.

Implementations§

Source§

impl RenderPipelineDesc

Source

pub fn from_wgpu(descriptor: &RenderPipelineDescriptor<'_>) -> Self

Own a borrowed render-pipeline descriptor, cloning every slice and handle.

Trait Implementations§

Source§

impl Clone for RenderPipelineDesc

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 RenderPipelineDesc

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RenderPipelineDesc

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl PipelineDescriptor<RenderPipeline> for RenderPipelineDesc

Source§

fn create(&self, device: &Device) -> RenderPipeline

Create the pipeline this descriptor describes.

The borrowed wgpu descriptor is assembled and consumed inside this function, so the owned vecs it borrows never outlive the call.

Source§

impl StructuralPartialEq for RenderPipelineDesc

Source§

impl SurfaceTarget for RenderPipelineDesc

Source§

fn set_surface(&mut self, surface: SurfaceKey)

The color format and sample count reach every fragment target, and the depth format the depth-stencil state.

A target with no depth attachment yields a descriptor with no depth state: wgpu rejects a pipeline that declares one against a pass that has none, so the state follows the target rather than keeping a stale format. A target that has one keeps whatever state the descriptor carried — the comparison, the write mask — and only takes the format.

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