Struct ShaderStages 

#[repr(C)]
pub struct ShaderStages {
    pub features_webgpu: ShaderStagesWebGPU,
    pub features_wgpu: ShaderStagesWGPU,
}

Describes the shader stages that a binding will be visible from.

These can be combined so something that is visible from both vertex and fragment shaders can be defined as:

ShaderStages::VERTEX | ShaderStages::FRAGMENT

Corresponds to WebGPU GPUShaderStageFlags.

Fields

features_webgpu: ShaderStagesWebGPU

features_wgpu: ShaderStagesWGPU

Implementations

impl ShaderStages

pub const NONE: ShaderStages

Binding is not visible from any shader stage.

pub const VERTEX: ShaderStages

Binding is visible from the vertex shader of a render pipeline.

pub const FRAGMENT: ShaderStages

Binding is visible from the fragment shader of a render pipeline.

pub const COMPUTE: ShaderStages

Binding is visible from the compute shader of a compute pipeline.

pub const VERTEX_FRAGMENT: ShaderStages

Binding is visible from the vertex and fragment shaders of a render pipeline.

pub const TASK: ShaderStages

Binding is visible from the task shader of a mesh pipeline.

pub const MESH: ShaderStages

Binding is visible from the mesh shader of a mesh pipeline.

pub const RAY_GENERATION: ShaderStages

Binding is visible from the ray generation shader of a ray tracing pipeline.

pub const ANY_HIT: ShaderStages

Binding is visible from the ray any hit shader of a ray tracing pipeline.

pub const CLOSEST_HIT: ShaderStages

Binding is visible from the ray closest hit shader of a ray tracing pipeline.

pub const MISS: ShaderStages

Binding is visible from the ray miss shader of a ray tracing pipeline.

pub const fn bits(&self) -> ShaderStagesBits

Gets the set flags as a container holding an array of bits.

pub const fn empty() -> ShaderStages

Returns self with no flags set.

pub const fn all() -> ShaderStages

Returns self with all flags set.

pub const fn contains(self, other: ShaderStages) -> bool

Whether all the bits set in other are all set in self

pub const fn intersects(self, other: ShaderStages) -> bool

Returns whether any bit set in self matched any bit set in other.

pub const fn is_empty(self) -> bool

Returns whether there is no flag set.

pub const fn is_all(self) -> bool

Returns whether the struct has all flags set.

pub const fn union(self, other: ShaderStages) -> ShaderStages

Bitwise or - self | other

pub const fn intersection(self, other: ShaderStages) -> ShaderStages

Bitwise and - self & other

pub const fn difference(self, other: ShaderStages) -> ShaderStages

Bitwise and of the complement of other - self & !other

pub const fn symmetric_difference(self, other: ShaderStages) -> ShaderStages

Bitwise xor - self ^ other

pub const fn complement(self) -> ShaderStages

Bitwise not - !self

pub fn set(&mut self, other: ShaderStages, set: bool)

Calls Self::insert if set is true and otherwise calls Self::remove.

pub fn insert(&mut self, other: ShaderStages)

Inserts specified flag(s) into self

pub fn remove(&mut self, other: ShaderStages)

Removes specified flag(s) from self

pub fn toggle(&mut self, other: ShaderStages)

Toggles specified flag(s) in self

pub const fn from_bits(bits: ShaderStagesBits) -> Option<ShaderStages>

Takes in ShaderStagesBits and returns None if there are invalid bits or otherwise Self with those bits set

pub const fn from_bits_truncate(bits: ShaderStagesBits) -> ShaderStages

Takes in ShaderStagesBits and returns Self with only valid bits (all other bits removed)

pub const fn from_bits_retain(bits: ShaderStagesBits) -> ShaderStages

Takes in ShaderStagesBits and returns Self with all bits that were set without removing invalid bits

pub fn from_name(name: &str) -> Option<ShaderStages>

Takes in a bitflags flag name (in SCREAMING_SNAKE_CASE) and returns Self if it matches or none if the name does not match the name of any of the flags. Name is capitalisation dependent.

[impl FromStr] can be used to recognize kebab-case names, like are used in the WebGPU spec.

pub fn from_internal_flags( features_webgpu: ShaderStagesWebGPU, features_wgpu: ShaderStagesWGPU, ) -> ShaderStages

Combines the flags from the internal flags into the entire flags struct

pub const fn iter(&self) -> Iter<ShaderStages>

Returns an iterator over the set flags.

pub const fn iter_names(&self) -> IterNames<ShaderStages>

Returns an iterator over the set flags and their names.

These are bitflags names in SCREAMING_SNAKE_CASE.

Trait Implementations

impl BitAnd for ShaderStages

type Output = ShaderStages

The resulting type after applying the & operator.

fn bitand(self, other: ShaderStages) -> ShaderStages

Performs the & operation.

impl BitAndAssign for ShaderStages

fn bitand_assign(&mut self, other: ShaderStages)

Performs the &= operation.

impl BitOr for ShaderStages

type Output = ShaderStages

The resulting type after applying the | operator.

fn bitor(self, other: ShaderStages) -> ShaderStages

Performs the | operation.

impl BitOrAssign for ShaderStages

fn bitor_assign(&mut self, other: ShaderStages)

Performs the |= operation.

impl BitXor for ShaderStages

type Output = ShaderStages

The resulting type after applying the ^ operator.

fn bitxor(self, other: ShaderStages) -> ShaderStages

Performs the ^ operation.

impl BitXorAssign for ShaderStages

fn bitxor_assign(&mut self, other: ShaderStages)

Performs the ^= operation.

impl Clone for ShaderStages

fn clone(&self) -> ShaderStages

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShaderStages

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShaderStages

Available on crate feature serde only.

fn deserialize<D>( deserializer: D, ) -> Result<ShaderStages, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ShaderStages

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

Formats the value using the given formatter.

impl Flags for ShaderStages

const FLAGS: &'static [Flag<ShaderStages>] = ShaderStages::FLAGS

The set of defined flags.

type Bits = ShaderStagesBits

The underlying bits type.

fn bits(&self) -> ShaderStagesBits

Get the underlying bits value.

fn from_bits_retain(bits: ShaderStagesBits) -> ShaderStages

Convert from a bits value exactly.

fn empty() -> ShaderStages

Get a flags value with all bits unset.

fn all() -> ShaderStages

Get a flags value with all known bits set.

fn all_named() -> Self

Get a flags value with all bits from named flags set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [Self::FLAGS].

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl From<ShaderStagesWGPU> for ShaderStages

fn from(features_wgpu: ShaderStagesWGPU) -> ShaderStages

Converts to this type from the input type.

impl From<ShaderStagesWebGPU> for ShaderStages

fn from(features_webgpu: ShaderStagesWebGPU) -> ShaderStages

Converts to this type from the input type.

impl Hash for ShaderStages

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

where __H: Hasher,

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 Not for ShaderStages

type Output = ShaderStages

The resulting type after applying the ! operator.

fn not(self) -> ShaderStages

Performs the unary ! operation.

impl PartialEq for ShaderStages

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

Available on crate feature serde only.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for ShaderStages

type Output = ShaderStages

The resulting type after applying the - operator.

fn sub(self, other: ShaderStages) -> ShaderStages

Performs the - operation.

impl Copy for ShaderStages

impl Eq for ShaderStages

impl StructuralPartialEq for ShaderStages