#[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
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§
impl Copy for Builtin
impl Eq for Builtin
impl StructuralPartialEq for Builtin
Auto Trait Implementations§
impl Freeze for Builtin
impl RefUnwindSafe for Builtin
impl Send for Builtin
impl Sync for Builtin
impl Unpin for Builtin
impl UnsafeUnpin for Builtin
impl UnwindSafe for Builtin
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.