Skip to main content

BuiltinValue

wgsl_types::syntax

Enum BuiltinValue 

Source 
pub enum BuiltinValue {

Show 47 variants    VertexIndex,
    InstanceIndex,
    ClipDistances,
    Position,
    FrontFacing,
    FragDepth,
    PrimitiveIndex,
    SampleIndex,
    SampleMask,
    LocalInvocationId,
    LocalInvocationIndex,
    GlobalInvocationId,
    GlobalInvocationIndex,
    WorkgroupId,
    WorkgroupIndex,
    NumWorkgroups,
    SubgroupInvocationId,
    SubgroupSize,
    SubgroupId,
    NumSubgroups,
    ViewIndex,
    DrawIndex,
    Barycentric,
    BarycentricNoPerspective,
    CullPrimitive,
    PointIndex,
    LineIndices,
    TriangleIndices,
    MeshTaskSize,
    VertexCount,
    Vertices,
    PrimitiveCount,
    Primitives,
    RayInvocationId,
    NumRayInvocations,
    InstanceCustomData,
    GeometryIndex,
    WorldRayOrigin,
    WorldRayDirection,
    ObjectRayOrigin,
    ObjectRayDirection,
    RayTMin,
    RayTCurrentMax,
    ObjectToWorld,
    WorldToObject,
    HitKind,
    HitBarycentrics,

}
Expand description

Built-in value names.

Context-dependent tokens.

Reference: https://www.w3.org/TR/WGSL/#builtin-value-names

Variants§

§

VertexIndex

§

InstanceIndex

§

ClipDistances

§

Position

§

FrontFacing

§

FragDepth

§

PrimitiveIndex

§

SampleIndex

§

SampleMask

§

LocalInvocationId

§

LocalInvocationIndex

§

GlobalInvocationId

§

GlobalInvocationIndex

§

WorkgroupId

§

WorkgroupIndex

§

NumWorkgroups

§

SubgroupInvocationId

§

SubgroupSize

§

SubgroupId

§

NumSubgroups

§

ViewIndex

§

DrawIndex

§

Barycentric

§

BarycentricNoPerspective

§

CullPrimitive

§

PointIndex

§

LineIndices

§

TriangleIndices

§

MeshTaskSize

§

VertexCount

§

Vertices

§

PrimitiveCount

§

Primitives

§

RayInvocationId

vec3<u32>, available in all ray tracing stages.

§

NumRayInvocations

vec3<u32>, available in all ray tracing stages.

§

InstanceCustomData

u32, available in the any_hit and closest_hit stages.

§

GeometryIndex

u32, available in the any_hit and closest_hit stages.

§

WorldRayOrigin

vec3<f32>, available in the any_hit, closest_hit and miss stages.

§

WorldRayDirection

vec3<f32>, available in the any_hit, closest_hit and miss stages.

§

ObjectRayOrigin

vec3<f32>, available in the any_hit and closest_hit stages.

§

ObjectRayDirection

vec3<f32>, available in the any_hit and closest_hit stages.

§

RayTMin

f32, available in the any_hit, closest_hit and miss stages.

§

RayTCurrentMax

f32, available in the any_hit, closest_hit and miss stages.

§

ObjectToWorld

mat4x3<f32>, available in the any_hit and closest_hit stages.

§

WorldToObject

mat4x3<f32>, available in the any_hit and closest_hit stages.

§

HitKind

u32, available in the any_hit and closest_hit stages.

§

HitBarycentrics

Trait Implementations§

Source§

impl Clone for BuiltinValue

Source§

fn clone(&self) -> BuiltinValue

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 BuiltinValue

Source§

impl Debug for BuiltinValue

Source§

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

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

impl Display for BuiltinValue

Source§

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

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

impl Eq for BuiltinValue

Source§

impl FromStr for BuiltinValue

Source§

type Err = ()

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for BuiltinValue

Source§

fn eq(&self, other: &BuiltinValue) -> 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 BuiltinValue

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

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

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.