Enum Stage 

#[non_exhaustive]
pub enum Stage {
    Vertex,
    Pixel,
    Compute,
    Hull,
    Domain,
    Geometry,
    Mesh,
    Amplification,
    RayGeneration,
    Intersection,
    AnyHit,
    ClosestHit,
    Miss,
    Callable,
}

The pipeline stage a program runs in.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Vertex

A vertex program: one invocation per vertex.

Pixel

A pixel (fragment) program: one invocation per covered pixel.

Compute

A compute program: no varyings, system inputs naming the invocation, a thread group size.

Hull

A hull program: the control-point phase and the patch-constant function of a tessellated patch (see super::StageFacts::Hull).

Domain

A domain program: a vertex of a tessellated patch from its domain location (see super::StageFacts::Domain).

Geometry

A geometry program.

Mesh

A mesh program: a thread group that writes the vertices and primitives of one meshlet (see super::StageFacts::Mesh); its outputs are the per-vertex varyings of the interface.

Amplification

An amplification (task) program: a thread group that launches mesh thread groups, handing each the words of its task payload (see super::StageFacts::Amplification). It has no varyings.

RayGeneration

A ray generation program: the start of a ray tracing dispatch, one invocation per dispatched ray position.

Intersection

An intersection program: tests a ray against a procedural primitive and reports hits.

AnyHit

An any-hit program: decides whether a candidate hit counts.

ClosestHit

A closest-hit program: runs for the nearest accepted hit of a traced ray.

Miss

A miss program: runs when a traced ray hits nothing.

Callable

A callable program: run by another ray tracing program (CallShader).

Implementations

impl Stage

pub fn has_thread_groups(self) -> bool

Whether a program of this stage runs in thread groups (numthreads): a compute, mesh or amplification program, whose invocations share workgroup memory and meet at a workgroup barrier.

pub fn is_ray_tracing(self) -> bool

Whether this is one of the ray tracing pipeline’s stages: a program of it is functions that read the ray’s system values and carry a payload, not an entry point (see iridia::stage_functions).

Trait Implementations

impl Clone for Stage

fn clone(&self) -> Stage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Stage

impl Debug for Stage

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

Formats the value using the given formatter.

impl Eq for Stage

impl Hash for Stage

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Stage

fn cmp(&self, other: &Stage) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Stage

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Stage

fn partial_cmp(&self, other: &Stage) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Stage

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Stage