Struct wgpu_types::ShaderStages
source · #[repr(transparent)]pub struct ShaderStages { /* private fields */ }
Expand description
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
.
Implementations§
source§impl ShaderStages
impl ShaderStages
sourcepub const VERTEX_FRAGMENT: Self = _
pub const VERTEX_FRAGMENT: Self = _
Binding is visible from the vertex and fragment shaders of a render pipeline.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§impl ShaderStages
impl ShaderStages
sourcepub fn contains_invalid_bits(&self) -> bool
pub fn contains_invalid_bits(&self) -> bool
Returns true if the bitflags contains bits that are not part of the bitflags definition.
Trait Implementations§
source§impl Binary for ShaderStages
impl Binary for ShaderStages
source§impl BitAnd<ShaderStages> for ShaderStages
impl BitAnd<ShaderStages> for ShaderStages
source§impl BitAndAssign<ShaderStages> for ShaderStages
impl BitAndAssign<ShaderStages> for ShaderStages
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<ShaderStages> for ShaderStages
impl BitOr<ShaderStages> for ShaderStages
source§fn bitor(self, other: ShaderStages) -> Self
fn bitor(self, other: ShaderStages) -> Self
Returns the union of the two sets of flags.
§type Output = ShaderStages
type Output = ShaderStages
|
operator.source§impl BitOrAssign<ShaderStages> for ShaderStages
impl BitOrAssign<ShaderStages> for ShaderStages
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ShaderStages> for ShaderStages
impl BitXor<ShaderStages> for ShaderStages
source§impl BitXorAssign<ShaderStages> for ShaderStages
impl BitXorAssign<ShaderStages> for ShaderStages
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ShaderStages
impl Clone for ShaderStages
source§fn clone(&self) -> ShaderStages
fn clone(&self) -> ShaderStages
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ShaderStages
impl Debug for ShaderStages
source§impl<'de> Deserialize<'de> for ShaderStages
Available on crate feature replay
only.
impl<'de> Deserialize<'de> for ShaderStages
replay
only.source§fn deserialize<D>(deserializer: D) -> Result<ShaderStages, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<ShaderStages, D::Error>where
D: Deserializer<'de>,
source§impl Extend<ShaderStages> for ShaderStages
impl Extend<ShaderStages> for ShaderStages
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<ShaderStages> for ShaderStages
impl FromIterator<ShaderStages> for ShaderStages
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for ShaderStages
impl Hash for ShaderStages
source§impl LowerHex for ShaderStages
impl LowerHex for ShaderStages
source§impl Not for ShaderStages
impl Not for ShaderStages
source§impl Octal for ShaderStages
impl Octal for ShaderStages
source§impl Ord for ShaderStages
impl Ord for ShaderStages
source§fn cmp(&self, other: &ShaderStages) -> Ordering
fn cmp(&self, other: &ShaderStages) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<ShaderStages> for ShaderStages
impl PartialEq<ShaderStages> for ShaderStages
source§fn eq(&self, other: &ShaderStages) -> bool
fn eq(&self, other: &ShaderStages) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ShaderStages> for ShaderStages
impl PartialOrd<ShaderStages> for ShaderStages
source§fn partial_cmp(&self, other: &ShaderStages) -> Option<Ordering>
fn partial_cmp(&self, other: &ShaderStages) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for ShaderStages
Available on crate feature trace
only.
impl Serialize for ShaderStages
trace
only.source§impl Sub<ShaderStages> for ShaderStages
impl Sub<ShaderStages> for ShaderStages
source§impl SubAssign<ShaderStages> for ShaderStages
impl SubAssign<ShaderStages> for ShaderStages
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.