Struct bevy_render::render_resource::ColorWrites
source · pub struct ColorWrites(/* private fields */);
Expand description
Color write mask. Disabled color channels will not be written to.
Corresponds to WebGPU GPUColorWriteFlags
.
Implementations§
source§impl ColorWrites
impl ColorWrites
sourcepub const RED: ColorWrites = _
pub const RED: ColorWrites = _
Enable red channel writes
sourcepub const GREEN: ColorWrites = _
pub const GREEN: ColorWrites = _
Enable green channel writes
sourcepub const BLUE: ColorWrites = _
pub const BLUE: ColorWrites = _
Enable blue channel writes
sourcepub const ALPHA: ColorWrites = _
pub const ALPHA: ColorWrites = _
Enable alpha channel writes
sourcepub const COLOR: ColorWrites = _
pub const COLOR: ColorWrites = _
Enable red, green, and blue channel writes
sourcepub const ALL: ColorWrites = _
pub const ALL: ColorWrites = _
Enable writes to all channels.
source§impl ColorWrites
impl ColorWrites
sourcepub const fn empty() -> ColorWrites
pub const fn empty() -> ColorWrites
Get a flags value with all bits unset.
sourcepub const fn all() -> ColorWrites
pub const fn all() -> ColorWrites
Get a flags value with all known bits set.
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<ColorWrites>
pub const fn from_bits(bits: u32) -> Option<ColorWrites>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> ColorWrites
pub const fn from_bits_truncate(bits: u32) -> ColorWrites
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> ColorWrites
pub const fn from_bits_retain(bits: u32) -> ColorWrites
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<ColorWrites>
pub fn from_name(name: &str) -> Option<ColorWrites>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: ColorWrites) -> bool
pub const fn intersects(&self, other: ColorWrites) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: ColorWrites) -> bool
pub const fn contains(&self, other: ColorWrites) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn insert(&mut self, other: ColorWrites)
pub fn insert(&mut self, other: ColorWrites)
The bitwise or (|
) of the bits in two flags values.
sourcepub fn remove(&mut self, other: ColorWrites)
pub fn remove(&mut self, other: ColorWrites)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: ColorWrites)
pub fn toggle(&mut self, other: ColorWrites)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: ColorWrites, value: bool)
pub fn set(&mut self, other: ColorWrites, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: ColorWrites) -> ColorWrites
pub const fn intersection(self, other: ColorWrites) -> ColorWrites
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: ColorWrites) -> ColorWrites
pub const fn union(self, other: ColorWrites) -> ColorWrites
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: ColorWrites) -> ColorWrites
pub const fn difference(self, other: ColorWrites) -> ColorWrites
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: ColorWrites) -> ColorWrites
pub const fn symmetric_difference(self, other: ColorWrites) -> ColorWrites
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> ColorWrites
pub const fn complement(self) -> ColorWrites
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl ColorWrites
impl ColorWrites
sourcepub const fn iter(&self) -> Iter<ColorWrites>
pub const fn iter(&self) -> Iter<ColorWrites>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<ColorWrites>
pub const fn iter_names(&self) -> IterNames<ColorWrites>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
source§impl ColorWrites
impl ColorWrites
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 ColorWrites
impl Binary for ColorWrites
source§impl BitAnd for ColorWrites
impl BitAnd for ColorWrites
source§fn bitand(self, other: ColorWrites) -> ColorWrites
fn bitand(self, other: ColorWrites) -> ColorWrites
The bitwise and (&
) of the bits in two flags values.
§type Output = ColorWrites
type Output = ColorWrites
&
operator.source§impl BitAndAssign for ColorWrites
impl BitAndAssign for ColorWrites
source§fn bitand_assign(&mut self, other: ColorWrites)
fn bitand_assign(&mut self, other: ColorWrites)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for ColorWrites
impl BitOr for ColorWrites
source§fn bitor(self, other: ColorWrites) -> ColorWrites
fn bitor(self, other: ColorWrites) -> ColorWrites
The bitwise or (|
) of the bits in two flags values.
§type Output = ColorWrites
type Output = ColorWrites
|
operator.source§impl BitOrAssign for ColorWrites
impl BitOrAssign for ColorWrites
source§fn bitor_assign(&mut self, other: ColorWrites)
fn bitor_assign(&mut self, other: ColorWrites)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for ColorWrites
impl BitXor for ColorWrites
source§fn bitxor(self, other: ColorWrites) -> ColorWrites
fn bitxor(self, other: ColorWrites) -> ColorWrites
The bitwise exclusive-or (^
) of the bits in two flags values.
§type Output = ColorWrites
type Output = ColorWrites
^
operator.source§impl BitXorAssign for ColorWrites
impl BitXorAssign for ColorWrites
source§fn bitxor_assign(&mut self, other: ColorWrites)
fn bitxor_assign(&mut self, other: ColorWrites)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for ColorWrites
impl Clone for ColorWrites
source§fn clone(&self) -> ColorWrites
fn clone(&self) -> ColorWrites
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ColorWrites
impl Debug for ColorWrites
source§impl Default for ColorWrites
impl Default for ColorWrites
source§fn default() -> ColorWrites
fn default() -> ColorWrites
source§impl Extend<ColorWrites> for ColorWrites
impl Extend<ColorWrites> for ColorWrites
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ColorWrites>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ColorWrites>,
The bitwise or (|
) of the bits in each flags value.
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 Flags for ColorWrites
impl Flags for ColorWrites
source§const FLAGS: &'static [Flag<ColorWrites>] = _
const FLAGS: &'static [Flag<ColorWrites>] = _
source§fn from_bits_retain(bits: u32) -> ColorWrites
fn from_bits_retain(bits: u32) -> ColorWrites
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<ColorWrites> for ColorWrites
impl FromIterator<ColorWrites> for ColorWrites
source§fn from_iter<T>(iterator: T) -> ColorWriteswhere
T: IntoIterator<Item = ColorWrites>,
fn from_iter<T>(iterator: T) -> ColorWriteswhere
T: IntoIterator<Item = ColorWrites>,
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for ColorWrites
impl Hash for ColorWrites
source§impl IntoIterator for ColorWrites
impl IntoIterator for ColorWrites
§type Item = ColorWrites
type Item = ColorWrites
§type IntoIter = Iter<ColorWrites>
type IntoIter = Iter<ColorWrites>
source§fn into_iter(self) -> <ColorWrites as IntoIterator>::IntoIter
fn into_iter(self) -> <ColorWrites as IntoIterator>::IntoIter
source§impl LowerHex for ColorWrites
impl LowerHex for ColorWrites
source§impl Not for ColorWrites
impl Not for ColorWrites
source§fn not(self) -> ColorWrites
fn not(self) -> ColorWrites
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§type Output = ColorWrites
type Output = ColorWrites
!
operator.source§impl Octal for ColorWrites
impl Octal for ColorWrites
source§impl PartialEq for ColorWrites
impl PartialEq for ColorWrites
source§fn eq(&self, other: &ColorWrites) -> bool
fn eq(&self, other: &ColorWrites) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Sub for ColorWrites
impl Sub for ColorWrites
source§fn sub(self, other: ColorWrites) -> ColorWrites
fn sub(self, other: ColorWrites) -> ColorWrites
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = ColorWrites
type Output = ColorWrites
-
operator.source§impl SubAssign for ColorWrites
impl SubAssign for ColorWrites
source§fn sub_assign(&mut self, other: ColorWrites)
fn sub_assign(&mut self, other: ColorWrites)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
source§impl UpperHex for ColorWrites
impl UpperHex for ColorWrites
impl Copy for ColorWrites
impl Eq for ColorWrites
impl StructuralPartialEq for ColorWrites
Auto Trait Implementations§
impl Freeze for ColorWrites
impl RefUnwindSafe for ColorWrites
impl Send for ColorWrites
impl Sync for ColorWrites
impl Unpin for ColorWrites
impl UnwindSafe for ColorWrites
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.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
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
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§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.source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.