Skip to main content

EnginePipeline

Enum EnginePipeline 

Source
pub enum EnginePipeline {
    StripIntermediate,
    StripAlpha,
    StripDepthAlpha,
    StripOpaque,
    StripDestOut,
    StripDepthDestOut,
    Clear,
    Copy,
    Filter,
}
Expand description

One of the engine’s render pipelines.

Variants§

§

StripIntermediate

Strips into an INTERMEDIATE_FORMAT off-screen target.

§

StripAlpha

Strips into the frame’s own target, alpha-blended, no depth.

§

StripDepthAlpha

Strips into the frame’s own target, alpha-blended, depth-tested but not depth-writing.

§

StripOpaque

Strips into the frame’s own target, opaque, depth-tested and depth-writing.

§

StripDestOut

Hole-punch coverage into the frame’s own target, destination-out, no depth.

§

StripDepthDestOut

Hole-punch coverage into the frame’s own target, destination-out, depth-tested but not depth-writing.

§

Clear

Clears rectangular regions of an intermediate target.

§

Copy

Copies rectangular regions between intermediate targets.

§

Filter

Runs one pass of a layer filter’s sequence into an intermediate target, reading the other page of the pair through a bilinear sampler.

Implementations§

Source§

impl EnginePipeline

Source

pub const ALL: [Self; 9]

Every pipeline the engine warms up, in warm-up order.

Source

pub const fn label(self) -> &'static str

A human-readable name for logs and captures.

Source

pub const fn is_strip(self) -> bool

Whether this pipeline rasterizes strips (as opposed to clearing or copying an intermediate).

Source

pub const fn bind_group_count(self) -> usize

How many bind groups the pipeline’s program declares.

Four is the WebGL2 ceiling, which the strip programs sit exactly on.

Source

pub const fn format(self, target_format: TextureFormat) -> TextureFormat

The color format this pipeline writes, given the frame’s target format.

Only the variants that draw into the frame’s own target take it; the rest are pinned to INTERMEDIATE_FORMAT.

Source

pub const fn blend(self) -> Option<BlendState>

The color blending this pipeline uses, or None for an opaque write.

Source

pub fn depth(self) -> Option<DepthStencilState>

The depth state this pipeline uses, or None for a color-only pass.

Source

pub fn vertex_layouts(self) -> Vec<VertexLayout>

The vertex buffer layouts this pipeline steps over.

Source

pub const fn module(self) -> EngineShaderModule

Which module this pipeline draws with.

Source

pub const fn shader(self, shaders: &EngineShaders) -> ShaderId

The registered id of the module this pipeline draws with.

Source

pub fn desc( self, shaders: &EngineShaders, target_format: TextureFormat, ) -> RenderPipelineDesc

The full pipeline description, ready for PipelineCache::get_or_create or PipelineCache::warm_up.

sample_count is always 1: the engine never multisamples, since a downlevel target cannot.

Source

pub fn layout_desc(self) -> PipelineLayoutDesc

This pipeline’s shape as the downlevel lint reads it, so the bind-group, vertex-topology and sample-count ceilings (frust_gpu::lint::lint_pipeline_layout) are checked against the real descriptions rather than restated by hand.

Trait Implementations§

Source§

impl Clone for EnginePipeline

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 Copy for EnginePipeline

Source§

impl Debug for EnginePipeline

Source§

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

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

impl Eq for EnginePipeline

Source§

impl Hash for EnginePipeline

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for EnginePipeline

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 StructuralPartialEq for EnginePipeline

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

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

Source§

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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

Source§

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

Source§

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

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

Source§

impl<T> WasmNotSendSync for T

Source§

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