Struct wgpu::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

source

pub const RED: ColorWrites = _

Enable red channel writes

source

pub const GREEN: ColorWrites = _

Enable green channel writes

source

pub const BLUE: ColorWrites = _

Enable blue channel writes

source

pub const ALPHA: ColorWrites = _

Enable alpha channel writes

source

pub const COLOR: ColorWrites = _

Enable red, green, and blue channel writes

source

pub const ALL: ColorWrites = _

Enable writes to all channels.

source§

impl ColorWrites

source

pub const fn empty() -> ColorWrites

Get a flags value with all bits unset.

source

pub const fn all() -> ColorWrites

Get a flags value with all known bits set.

source

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

source

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.

source

pub const fn from_bits_truncate(bits: u32) -> ColorWrites

Convert from a bits value, unsetting any unknown bits.

source

pub const fn from_bits_retain(bits: u32) -> ColorWrites

Convert from a bits value exactly.

source

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.

source

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

source

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

source

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.

source

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.

source

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

The bitwise or (|) of the bits in two flags values.

source

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.

source

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

The bitwise exclusive-or (^) of the bits in two flags values.

source

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

Call insert when value is true or remove when value is false.

source

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

The bitwise and (&) of the bits in two flags values.

source

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

The bitwise or (|) of the bits in two flags values.

source

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.

source

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

The bitwise exclusive-or (^) of the bits in two flags values.

source

pub const fn complement(self) -> ColorWrites

The bitwise negation (!) of the bits in a flags value, truncating the result.

source§

impl ColorWrites

source

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.

source

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

source

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

source§

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

Formats the value using the given formatter.
source§

impl BitAnd for ColorWrites

source§

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

The bitwise and (&) of the bits in two flags values.

§

type Output = ColorWrites

The resulting type after applying the & operator.
source§

impl BitAndAssign for ColorWrites

source§

fn bitand_assign(&mut self, other: ColorWrites)

The bitwise and (&) of the bits in two flags values.

source§

impl BitOr for ColorWrites

source§

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

The bitwise or (|) of the bits in two flags values.

§

type Output = ColorWrites

The resulting type after applying the | operator.
source§

impl BitOrAssign for ColorWrites

source§

fn bitor_assign(&mut self, other: ColorWrites)

The bitwise or (|) of the bits in two flags values.

source§

impl BitXor for ColorWrites

source§

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

The bitwise exclusive-or (^) of the bits in two flags values.

§

type Output = ColorWrites

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for ColorWrites

source§

fn bitxor_assign(&mut self, other: ColorWrites)

The bitwise exclusive-or (^) of the bits in two flags values.

source§

impl Clone for ColorWrites

source§

fn clone(&self) -> ColorWrites

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ColorWrites

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ColorWrites

source§

fn default() -> ColorWrites

Returns the “default value” for a type. Read more
source§

impl Extend<ColorWrites> for ColorWrites

source§

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)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Flags for ColorWrites

source§

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

The set of defined flags.
§

type Bits = u32

The underlying bits type.
source§

fn bits(&self) -> u32

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u32) -> ColorWrites

Convert from a bits value exactly.
source§

fn empty() -> Self

Get a flags value with all bits unset.
source§

fn all() -> Self

Get a flags value with all known bits set.
source§

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

Convert from a bits value. Read more
source§

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

Convert from a bits value, unsetting any unknown bits.
source§

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

Get a flags value with the bits of a flag with the given name set. Read more
source§

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

Yield a set of contained flags values. Read more
source§

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

Yield a set of contained named flags values. Read more
source§

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.
source§

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.
source§

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

Whether any set bits in a source flags value are also set in a target flags value.
source§

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

Whether all set bits in a source flags value are also set in a target flags value.
source§

fn insert(&mut self, other: Self)
where Self: Sized,

The bitwise or (|) of the bits in two flags values.
source§

fn remove(&mut self, other: Self)
where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.
source§

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.
source§

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

The bitwise and (&) of the bits in two flags values.
source§

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

The bitwise or (|) of the bits in two flags values.
source§

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

The intersection of a source flags value with the complement of a target flags value (&!). Read more
source§

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

The bitwise exclusive-or (^) of the bits in two flags values.
source§

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.
source§

impl FromIterator<ColorWrites> for ColorWrites

source§

fn from_iter<T>(iterator: T) -> ColorWrites
where T: IntoIterator<Item = ColorWrites>,

The bitwise or (|) of the bits in each flags value.

source§

impl Hash for ColorWrites

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl IntoIterator for ColorWrites

§

type Item = ColorWrites

The type of the elements being iterated over.
§

type IntoIter = Iter<ColorWrites>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> <ColorWrites as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for ColorWrites

source§

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

Formats the value using the given formatter.
source§

impl Not for ColorWrites

source§

fn not(self) -> ColorWrites

The bitwise negation (!) of the bits in a flags value, truncating the result.

§

type Output = ColorWrites

The resulting type after applying the ! operator.
source§

impl Octal for ColorWrites

source§

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

Formats the value using the given formatter.
source§

impl PartialEq for ColorWrites

source§

fn eq(&self, other: &ColorWrites) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Sub for ColorWrites

source§

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

The resulting type after applying the - operator.
source§

impl SubAssign for ColorWrites

source§

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

source§

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

Formats the value using the given formatter.
source§

impl Copy for ColorWrites

source§

impl Eq for ColorWrites

source§

impl StructuralEq for ColorWrites

source§

impl StructuralPartialEq for ColorWrites

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,