Enum spirv_headers::BuiltIn

[−] Show declaration

[+] Expand attributes
#[repr(u32)]pub enum BuiltIn {
    Position,
    PointSize,
    ClipDistance,
    CullDistance,
    VertexId,
    InstanceId,
    PrimitiveId,
    InvocationId,
    Layer,
    ViewportIndex,
    TessLevelOuter,
    TessLevelInner,
    TessCoord,
    PatchVertices,
    FragCoord,
    PointCoord,
    FrontFacing,
    SampleId,
    SamplePosition,
    SampleMask,
    FragDepth,
    HelperInvocation,
    NumWorkgroups,
    WorkgroupSize,
    WorkgroupId,
    LocalInvocationId,
    GlobalInvocationId,
    LocalInvocationIndex,
    WorkDim,
    GlobalSize,
    EnqueuedWorkgroupSize,
    GlobalOffset,
    GlobalLinearId,
    SubgroupSize,
    SubgroupMaxSize,
    NumSubgroups,
    NumEnqueuedSubgroups,
    SubgroupId,
    SubgroupLocalInvocationId,
    VertexIndex,
    InstanceIndex,
    SubgroupEqMask,
    SubgroupGeMask,
    SubgroupGtMask,
    SubgroupLeMask,
    SubgroupLtMask,
    BaseVertex,
    BaseInstance,
    DrawIndex,
    DeviceIndex,
    ViewIndex,
    BaryCoordNoPerspAMD,
    BaryCoordNoPerspCentroidAMD,
    BaryCoordNoPerspSampleAMD,
    BaryCoordSmoothAMD,
    BaryCoordSmoothCentroidAMD,
    BaryCoordSmoothSampleAMD,
    BaryCoordPullModelAMD,
    FragStencilRefEXT,
    ViewportMaskNV,
    SecondaryPositionNV,
    SecondaryViewportMaskNV,
    PositionPerViewNV,
    ViewportMaskPerViewNV,
    FullyCoveredEXT,
    TaskCountNV,
    PrimitiveCountNV,
    PrimitiveIndicesNV,
    ClipDistancePerViewNV,
    CullDistancePerViewNV,
    LayerPerViewNV,
    MeshViewCountNV,
    MeshViewIndicesNV,
    BaryCoordNV,
    BaryCoordNoPerspNV,
    FragSizeEXT,
    FragInvocationCountEXT,
    LaunchIdNV,
    LaunchSizeNV,
    WorldRayOriginNV,
    WorldRayDirectionNV,
    ObjectRayOriginNV,
    ObjectRayDirectionNV,
    RayTminNV,
    RayTmaxNV,
    InstanceCustomIndexNV,
    ObjectToWorldNV,
    WorldToObjectNV,
    HitTNV,
    HitKindNV,
    IncomingRayFlagsNV,
    RayGeometryIndexKHR,
    WarpsPerSMNV,
    SMCountNV,
    WarpIDNV,
    SMIDNV,
}

[−] Expand description

/// SPIR-V operand kind: BuiltIn

Variants

Position

PointSize

ClipDistance

CullDistance

VertexId

InstanceId

PrimitiveId

InvocationId

Layer

ViewportIndex

TessLevelOuter

TessLevelInner

TessCoord

PatchVertices

FragCoord

PointCoord

FrontFacing

SampleId

SamplePosition

SampleMask

FragDepth

HelperInvocation

NumWorkgroups

WorkgroupSize

WorkgroupId

LocalInvocationId

GlobalInvocationId

LocalInvocationIndex

WorkDim

GlobalSize

EnqueuedWorkgroupSize

GlobalOffset

GlobalLinearId

SubgroupSize

SubgroupMaxSize

NumSubgroups

NumEnqueuedSubgroups

SubgroupId

SubgroupLocalInvocationId

VertexIndex

InstanceIndex

SubgroupEqMask

SubgroupGeMask

SubgroupGtMask

SubgroupLeMask

SubgroupLtMask

BaseVertex

BaseInstance

DrawIndex

DeviceIndex

ViewIndex

BaryCoordNoPerspAMD

BaryCoordNoPerspCentroidAMD

BaryCoordNoPerspSampleAMD

BaryCoordSmoothAMD

BaryCoordSmoothCentroidAMD

BaryCoordSmoothSampleAMD

BaryCoordPullModelAMD

FragStencilRefEXT

ViewportMaskNV

SecondaryPositionNV

SecondaryViewportMaskNV

PositionPerViewNV

ViewportMaskPerViewNV

FullyCoveredEXT

TaskCountNV

PrimitiveCountNV

PrimitiveIndicesNV

ClipDistancePerViewNV

CullDistancePerViewNV

LayerPerViewNV

MeshViewCountNV

MeshViewIndicesNV

BaryCoordNV

BaryCoordNoPerspNV

FragSizeEXT

FragInvocationCountEXT

LaunchIdNV

LaunchSizeNV

WorldRayOriginNV

WorldRayDirectionNV

ObjectRayOriginNV

ObjectRayDirectionNV

RayTminNV

RayTmaxNV

InstanceCustomIndexNV

ObjectToWorldNV

WorldToObjectNV

HitTNV

HitKindNV

IncomingRayFlagsNV

RayGeometryIndexKHR

WarpsPerSMNV

SMCountNV

WarpIDNV

SMIDNV

Implementations

impl BuiltIn[−]

pub const SubgroupEqMaskKHR: BuiltIn

pub const SubgroupGeMaskKHR: BuiltIn

pub const SubgroupGtMaskKHR: BuiltIn

pub const SubgroupLeMaskKHR: BuiltIn

pub const SubgroupLtMaskKHR: BuiltIn

pub const FragmentSizeNV: BuiltIn

pub const InvocationsPerPixelNV: BuiltIn

pub const LaunchIdKHR: BuiltIn

pub const LaunchSizeKHR: BuiltIn

pub const WorldRayOriginKHR: BuiltIn

pub const WorldRayDirectionKHR: BuiltIn

pub const ObjectRayOriginKHR: BuiltIn

pub const ObjectRayDirectionKHR: BuiltIn

pub const RayTminKHR: BuiltIn

pub const RayTmaxKHR: BuiltIn

pub const InstanceCustomIndexKHR: BuiltIn

pub const ObjectToWorldKHR: BuiltIn

pub const WorldToObjectKHR: BuiltIn

pub const HitTKHR: BuiltIn

pub const HitKindKHR: BuiltIn

pub const IncomingRayFlagsKHR: BuiltIn

pub fn required_capabilities(self) -> &'static [Capability]

Trait Implementations

impl Clone for BuiltIn[+]

[+] Show hidden undocumented items

fn clone(&self) -> BuiltIn[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for BuiltIn

impl Debug for BuiltIn[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for BuiltIn

impl FromPrimitive for BuiltIn[+]

[+] Show hidden undocumented items

fn from_i64(n: i64) -> Option<Self>[−]

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>[−]

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>[−]

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>[−]

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>[−]

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>[−]

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>[−]

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>[−]

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>[−]

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>[−]

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>[−]

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>[−]

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>[−]

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>[−]

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Hash for BuiltIn[+]

[+] Show hidden undocumented items

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, [−]

Feeds a slice of this type into the given Hasher.

impl Ord for BuiltIn[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &BuiltIn) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[−]

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

Restrict a value to a certain interval.

impl PartialEq<BuiltIn> for BuiltIn[+]

[+] Show hidden undocumented items

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

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialOrd<BuiltIn> for BuiltIn[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &BuiltIn) -> Option<Ordering>[−]

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

[+] Expand attributes

#[must_use]fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]fn le(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use]fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]fn ge(&self, other: &Rhs) -> bool[−]

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

impl StructuralEq for BuiltIn

impl StructuralPartialEq for BuiltIn