Struct wgpu::TextureFormatFeatureFlags

#[repr(transparent)]
pub struct TextureFormatFeatureFlags { /* fields omitted */ }

Feature flags for a texture format.

Implementations

impl TextureFormatFeatureFlags

pub const STORAGE_READ_WRITE: TextureFormatFeatureFlags

When used as a STORAGE texture, then a texture with this format can be bound with StorageTextureAccess::ReadOnly or StorageTextureAccess::ReadWrite.

pub const STORAGE_ATOMICS: TextureFormatFeatureFlags

When used as a STORAGE texture, then a texture with this format can be written to with atomics.

pub const fn empty() -> TextureFormatFeatureFlags

Returns an empty set of flags.

pub const fn all() -> TextureFormatFeatureFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<TextureFormatFeatureFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> TextureFormatFeatureFlags

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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

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.

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

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.

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

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.

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

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.

pub const fn complement(self) -> TextureFormatFeatureFlags

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.

Trait Implementations

impl Binary for TextureFormatFeatureFlags

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

Formats the value using the given formatter.

impl BitAnd<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn bitand(
    self,
    other: TextureFormatFeatureFlags
) -> TextureFormatFeatureFlags

Returns the intersection between the two sets of flags.

type Output = TextureFormatFeatureFlags

The resulting type after applying the & operator.

impl BitAndAssign<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn bitand_assign(&mut self, other: TextureFormatFeatureFlags)

Disables all flags disabled in the set.

impl BitOr<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn bitor(
    self,
    other: TextureFormatFeatureFlags
) -> TextureFormatFeatureFlags

Returns the union of the two sets of flags.

type Output = TextureFormatFeatureFlags

The resulting type after applying the | operator.

impl BitOrAssign<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn bitor_assign(&mut self, other: TextureFormatFeatureFlags)

Adds the set of flags.

impl BitXor<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn bitxor(
    self,
    other: TextureFormatFeatureFlags
) -> TextureFormatFeatureFlags

Returns the left flags, but with all the right flags toggled.

type Output = TextureFormatFeatureFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn bitxor_assign(&mut self, other: TextureFormatFeatureFlags)

Toggles the set of flags.

impl Clone for TextureFormatFeatureFlags

pub fn clone(&self) -> TextureFormatFeatureFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextureFormatFeatureFlags

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

Formats the value using the given formatter.

impl Extend<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = TextureFormatFeatureFlags>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.

impl FromIterator<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

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

Creates a value from an iterator.

impl Hash for TextureFormatFeatureFlags

pub 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, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for TextureFormatFeatureFlags

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

Formats the value using the given formatter.

impl Not for TextureFormatFeatureFlags

pub fn not(self) -> TextureFormatFeatureFlags

Returns the complement of this set of flags.

type Output = TextureFormatFeatureFlags

The resulting type after applying the ! operator.

impl Octal for TextureFormatFeatureFlags

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

Formats the value using the given formatter.

impl Ord for TextureFormatFeatureFlags

pub fn cmp(&self, other: &TextureFormatFeatureFlags) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

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

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

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

This method tests for !=.

impl PartialOrd<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn partial_cmp(&self, other: &TextureFormatFeatureFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn sub(self, other: TextureFormatFeatureFlags) -> TextureFormatFeatureFlags

Returns the set difference of the two sets of flags.

type Output = TextureFormatFeatureFlags

The resulting type after applying the - operator.

impl SubAssign<TextureFormatFeatureFlags> for TextureFormatFeatureFlags

pub fn sub_assign(&mut self, other: TextureFormatFeatureFlags)

Disables all flags enabled in the set.

impl UpperHex for TextureFormatFeatureFlags

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

Formats the value using the given formatter.

impl Copy for TextureFormatFeatureFlags

impl Eq for TextureFormatFeatureFlags

impl StructuralEq for TextureFormatFeatureFlags

impl StructuralPartialEq for TextureFormatFeatureFlags