Struct wgpu::ShaderStages
source · 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 NONE: ShaderStages = Self{ bits: 0,}
pub const NONE: ShaderStages = Self{ bits: 0,}
Binding is not visible from any shader stage.
sourcepub const VERTEX: ShaderStages = Self{ bits: 1 << 0,}
pub const VERTEX: ShaderStages = Self{ bits: 1 << 0,}
Binding is visible from the vertex shader of a render pipeline.
sourcepub const FRAGMENT: ShaderStages = Self{ bits: 1 << 1,}
pub const FRAGMENT: ShaderStages = Self{ bits: 1 << 1,}
Binding is visible from the fragment shader of a render pipeline.
sourcepub const COMPUTE: ShaderStages = Self{ bits: 1 << 2,}
pub const COMPUTE: ShaderStages = Self{ bits: 1 << 2,}
Binding is visible from the compute shader of a compute pipeline.
sourcepub const VERTEX_FRAGMENT: ShaderStages = Self{ bits: Self::VERTEX.bits | Self::FRAGMENT.bits,}
pub const VERTEX_FRAGMENT: ShaderStages = Self{ bits: Self::VERTEX.bits | Self::FRAGMENT.bits,}
Binding is visible from the vertex and fragment shaders of a render pipeline.
sourcepub const fn empty() -> ShaderStages
pub const fn empty() -> ShaderStages
Returns an empty set of flags.
sourcepub const fn all() -> ShaderStages
pub const fn all() -> ShaderStages
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<ShaderStages>
pub const fn from_bits(bits: u32) -> Option<ShaderStages>
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) -> ShaderStages
pub const fn from_bits_truncate(bits: u32) -> ShaderStages
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> ShaderStages
pub const unsafe fn from_bits_unchecked(bits: u32) -> ShaderStages
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: ShaderStages) -> bool
pub const fn intersects(&self, other: ShaderStages) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: ShaderStages) -> bool
pub const fn contains(&self, other: ShaderStages) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: ShaderStages)
pub fn insert(&mut self, other: ShaderStages)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: ShaderStages)
pub fn remove(&mut self, other: ShaderStages)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: ShaderStages)
pub fn toggle(&mut self, other: ShaderStages)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: ShaderStages, value: bool)
pub fn set(&mut self, other: ShaderStages, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: ShaderStages) -> ShaderStages
pub const fn intersection(self, other: ShaderStages) -> ShaderStages
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: ShaderStages) -> ShaderStages
pub const fn union(self, other: ShaderStages) -> ShaderStages
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: ShaderStages) -> ShaderStages
pub const fn difference(self, other: ShaderStages) -> ShaderStages
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: ShaderStages) -> ShaderStages
pub const fn symmetric_difference(self, other: ShaderStages) -> ShaderStages
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) -> ShaderStages
pub const fn complement(self) -> ShaderStages
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§fn bitand(self, other: ShaderStages) -> ShaderStages
fn bitand(self, other: ShaderStages) -> ShaderStages
Returns the intersection between the two sets of flags.
§type Output = ShaderStages
type Output = ShaderStages
&
operator.source§impl BitAndAssign<ShaderStages> for ShaderStages
impl BitAndAssign<ShaderStages> for ShaderStages
source§fn bitand_assign(&mut self, other: ShaderStages)
fn bitand_assign(&mut self, other: ShaderStages)
Disables all flags disabled in the set.
source§impl BitOr<ShaderStages> for ShaderStages
impl BitOr<ShaderStages> for ShaderStages
source§fn bitor(self, other: ShaderStages) -> ShaderStages
fn bitor(self, other: ShaderStages) -> ShaderStages
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: ShaderStages)
fn bitor_assign(&mut self, other: ShaderStages)
Adds the set of flags.
source§impl BitXor<ShaderStages> for ShaderStages
impl BitXor<ShaderStages> for ShaderStages
source§fn bitxor(self, other: ShaderStages) -> ShaderStages
fn bitxor(self, other: ShaderStages) -> ShaderStages
Returns the left flags, but with all the right flags toggled.
§type Output = ShaderStages
type Output = ShaderStages
^
operator.source§impl BitXorAssign<ShaderStages> for ShaderStages
impl BitXorAssign<ShaderStages> for ShaderStages
source§fn bitxor_assign(&mut self, other: ShaderStages)
fn bitxor_assign(&mut self, other: ShaderStages)
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 Extend<ShaderStages> for ShaderStages
impl Extend<ShaderStages> for ShaderStages
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ShaderStages>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = ShaderStages>,
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>(iterator: T) -> ShaderStageswhere
T: IntoIterator<Item = ShaderStages>,
fn from_iter<T>(iterator: T) -> ShaderStageswhere T: IntoIterator<Item = ShaderStages>,
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§fn not(self) -> ShaderStages
fn not(self) -> ShaderStages
Returns the complement of this set of flags.
§type Output = ShaderStages
type Output = ShaderStages
!
operator.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 Sub<ShaderStages> for ShaderStages
impl Sub<ShaderStages> for ShaderStages
source§fn sub(self, other: ShaderStages) -> ShaderStages
fn sub(self, other: ShaderStages) -> ShaderStages
Returns the set difference of the two sets of flags.
§type Output = ShaderStages
type Output = ShaderStages
-
operator.source§impl SubAssign<ShaderStages> for ShaderStages
impl SubAssign<ShaderStages> for ShaderStages
source§fn sub_assign(&mut self, other: ShaderStages)
fn sub_assign(&mut self, other: ShaderStages)
Disables all flags enabled in the set.
source§impl UpperHex for ShaderStages
impl UpperHex for ShaderStages
impl Copy for ShaderStages
impl Eq for ShaderStages
impl StructuralEq for ShaderStages
impl StructuralPartialEq for ShaderStages
Auto Trait Implementations§
impl RefUnwindSafe for ShaderStages
impl Send for ShaderStages
impl Sync for ShaderStages
impl Unpin for ShaderStages
impl UnwindSafe for ShaderStages
Blanket Implementations§
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.