Skip to main content

Builtin

Enum Builtin 

Source
#[non_exhaustive]
pub enum Builtin { VertexIndex, InstanceIndex, FragCoord, FrontFacing, InvocationLocalIndex, WorkgroupId, LocalId, GlobalId, NumWorkgroups, SubgroupSize, InvocationSubgroupIndex, SubgroupIndex, }
Expand description

A WGSL builtin input.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

VertexIndex

@builtin( vertex_index ).

§

InstanceIndex

@builtin( instance_index ).

§

FragCoord

@builtin( position ) in the fragment stage.

§

FrontFacing

@builtin( front_facing ) — FrontFacingNode.

§

InvocationLocalIndex

invocationLocalIndex — @builtin( local_invocation_index ), which WGSLNodeBuilder.getInvocationLocalIndex() adds to the compute entry point’s parameters only when a kernel reads it.

§

WorkgroupId

workgroupId / localId / globalId / numWorkgroups — ComputeBuiltinNode. The compute entry point always declares these four (WGSLNodeBuilder.getAttributes( 'compute' )), so reading one only names the parameter.

§

LocalId

@builtin( local_invocation_id ) — see Builtin::WorkgroupId.

§

GlobalId

@builtin( global_invocation_id ) — see Builtin::WorkgroupId.

§

NumWorkgroups

@builtin( num_workgroups ) — see Builtin::WorkgroupId.

§

SubgroupSize

subgroupSize — @builtin( subgroup_size ). Three’s computeBuiltin( 'subgroupSize', 'uint' ) only writes the name: the parameter is the one WGSLNodeBuilder.getAttributes( 'compute' ) appends after the four above when the device has subgroups. The port declares it, and enable subgroups;, when a kernel reads it or calls a subgroup function (docs/nodes.md §84).

§

InvocationSubgroupIndex

invocationSubgroupIndex — @builtin( subgroup_invocation_id ), registered by WGSLNodeBuilder.getInvocationSubgroupIndex() when the flow reads it, so it comes before the four fixed parameters, like Builtin::InvocationLocalIndex.

§

SubgroupIndex

subgroupIndex — @builtin( subgroup_id ), registered by WGSLNodeBuilder.getSubgroupIndex(); see Builtin::InvocationSubgroupIndex.

Trait Implementations§

Source§

impl Clone for Builtin

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 Builtin

Source§

impl Debug for Builtin

Source§

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

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

impl Eq for Builtin

Source§

impl PartialEq for Builtin

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 Builtin

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> 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,