Enum BuiltIn 

pub enum BuiltIn {
    PrimitiveIndex,
    Position {
        invariant: bool,
    },
    ViewIndex,
    BaseInstance,
    BaseVertex,
    ClipDistance,
    CullDistance,
    InstanceIndex,
    PointSize,
    VertexIndex,
    DrawIndex,
    FragDepth,
    PointCoord,
    FrontFacing,
    Barycentric {
        perspective: bool,
    },
    SampleIndex,
    SampleMask,
    GlobalInvocationId,
    LocalInvocationId,
    LocalInvocationIndex,
    WorkGroupId,
    WorkGroupSize,
    NumWorkGroups,
    NumSubgroups,
    SubgroupId,
    SubgroupSize,
    SubgroupInvocationId,
    MeshTaskSize,
    CullPrimitive,
    PointIndex,
    LineIndices,
    TriangleIndices,
    VertexCount,
    Vertices,
    PrimitiveCount,
    Primitives,
    RayInvocationId,
    NumRayInvocations,
    InstanceCustomData,
    GeometryIndex,
    WorldRayOrigin,
    WorldRayDirection,
    ObjectRayOrigin,
    ObjectRayDirection,
    RayTmin,
    RayTCurrentMax,
    ObjectToWorld,
    WorldToObject,
    HitKind,
}

Built-in inputs and outputs.

Variants

PrimitiveIndex

Read in fragment shaders, written in mesh shaders, read in any and closest hit shaders.

Position

Written in vertex/mesh shaders, read in fragment shaders

Fields

invariant: bool

ViewIndex

Read in task, mesh, vertex, and fragment shaders

BaseInstance

Read in vertex shaders

BaseVertex

Read in vertex shaders

ClipDistance

Written in vertex & mesh shaders

CullDistance

Written in vertex & mesh shaders

InstanceIndex

Read in vertex, any- and closest-hit shaders

PointSize

Written in vertex & mesh shaders

VertexIndex

Read in vertex shaders

DrawIndex

Read in vertex & task shaders, or mesh shaders in pipelines without task shaders

FragDepth

Written in fragment shaders

PointCoord

Read in fragment shaders

FrontFacing

Read in fragment shaders

Barycentric

Read in fragment shaders

Fields

perspective: bool

SampleIndex

Read in fragment shaders

SampleMask

Read or written in fragment shaders

GlobalInvocationId

Read in compute, task, and mesh shaders

LocalInvocationId

Read in compute, task, and mesh shaders

LocalInvocationIndex

Read in compute, task, and mesh shaders

WorkGroupId

Read in compute, task, and mesh shaders

WorkGroupSize

Read in compute, task, and mesh shaders

NumWorkGroups

Read in compute, task, and mesh shaders

NumSubgroups

Read in compute, task, and mesh shaders

SubgroupId

Read in compute, task, and mesh shaders

SubgroupSize

Read in compute, fragment, task, and mesh shaders

SubgroupInvocationId

Read in compute, fragment, task, and mesh shaders

MeshTaskSize

Written in task shaders

CullPrimitive

Written in mesh shaders

PointIndex

Written in mesh shaders

LineIndices

Written in mesh shaders

TriangleIndices

Written in mesh shaders

VertexCount

Written to a workgroup variable in mesh shaders

Vertices

Written to a workgroup variable in mesh shaders

PrimitiveCount

Written to a workgroup variable in mesh shaders

Primitives

Written to a workgroup variable in mesh shaders

RayInvocationId

Read in all ray tracing pipeline shaders, the id within the number of rays that this current ray is.

NumRayInvocations

Read in all ray tracing pipeline shaders, the number of rays created.

InstanceCustomData

Read in closest hit and any hit shaders, the custom data in the tlas instance

GeometryIndex

Read in closest hit and any hit shaders, the index of the geometry in the blas.

WorldRayOrigin

Read in closest hit, any hit, and miss shaders, the origin of the ray.

WorldRayDirection

Read in closest hit, any hit, and miss shaders, the direction of the ray.

ObjectRayOrigin

Read in closest hit and any hit shaders, the direction of the ray in object space.

ObjectRayDirection

Read in closest hit and any hit shaders, the direction of the ray in object space.

RayTmin

Read in closest hit, any hit, and miss shaders, the t min provided by in the ray desc.

RayTCurrentMax

Read in closest hit, any hit, and miss shaders, the final bounds at which a hit is accepted (the closest committed hit if there is one otherwise, t max provided in the ray desc).

ObjectToWorld

Read in closest hit and any hit shaders, the matrix for converting from object space to world space

WorldToObject

Read in closest hit and any hit shaders, the matrix for converting from world space to object space

HitKind

Read in closest hit and any hit shaders, the type of hit as provided by the intersection function if any, otherwise this is 254 (0xFE) for a front facing triangle and 255 (0xFF) for a back facing triangle

Trait Implementations

impl Clone for BuiltIn

fn clone(&self) -> BuiltIn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BuiltIn

impl Debug for BuiltIn

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

Formats the value using the given formatter.

impl Eq for BuiltIn

impl Hash for BuiltIn

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

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 BuiltIn

fn cmp(&self, other: &BuiltIn) -> 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.

impl PartialEq for BuiltIn

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BuiltIn

fn partial_cmp(&self, other: &BuiltIn) -> 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 StructuralPartialEq for BuiltIn

impl TryToWgsl for BuiltIn

const DESCRIPTION: &'static str = "builtin value"

What kind of WGSL thing Self represents.

fn try_to_wgsl(self) -> Option<&'static str>

Return the WGSL form of self as a 'static string.

fn to_wgsl_for_diagnostics(self) -> String

where Self: Debug + Copy,

Return the WGSL form of self as appropriate for diagnostics.