Struct wgpu::core::naga::valid::TypeFlags

pub struct TypeFlags(/* private fields */);

Available on wgpu_core only.

Flags associated with Types by Validator.

Implementations

impl TypeFlags

pub const DATA: TypeFlags = _

Can be used for data variables.

This flag is required on types of local variables, function arguments, array elements, and struct members.

This includes all types except Image, Sampler, and some Pointer types.

pub const SIZED: TypeFlags = _

The data type has a size known by pipeline creation time.

Unsized types are quite restricted. The only unsized types permitted by Naga, other than the non-DATA types like Image and Sampler, are dynamically-sized [Arrays], and [Structs] whose last members are such arrays. See the documentation for those types for details.

pub const COPY: TypeFlags = _

The data can be copied around.

pub const IO_SHAREABLE: TypeFlags = _

Can be be used for user-defined IO between pipeline stages.

This covers anything that can be in [Location] binding: non-bool scalars and vectors, matrices, and structs and arrays containing only interface types.

pub const HOST_SHAREABLE: TypeFlags = _

Can be used for host-shareable structures.

pub const ARGUMENT: TypeFlags = _

This type can be passed as a function argument.

pub const CONSTRUCTIBLE: TypeFlags = _

A WGSL constructible type.

The constructible types are scalars, vectors, matrices, fixed-size arrays of constructible types, and structs whose members are all constructible.

impl TypeFlags

pub const fn empty() -> TypeFlags

Get a flags value with all bits unset.

pub const fn all() -> TypeFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

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

pub const fn from_bits(bits: u8) -> Option<TypeFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> TypeFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> TypeFlags

Convert from a bits value exactly.

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

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.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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.

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

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

pub const fn complement(self) -> TypeFlags

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

impl TypeFlags

pub const fn iter(&self) -> Iter<TypeFlags>

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.

pub const fn iter_names(&self) -> IterNames<TypeFlags>

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.

Trait Implementations

impl Binary for TypeFlags

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

Formats the value using the given formatter.

impl BitAnd for TypeFlags

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

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

type Output = TypeFlags

The resulting type after applying the & operator.

impl BitAndAssign for TypeFlags

fn bitand_assign(&mut self, other: TypeFlags)

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

impl BitOr for TypeFlags

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

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

type Output = TypeFlags

The resulting type after applying the | operator.

impl BitOrAssign for TypeFlags

fn bitor_assign(&mut self, other: TypeFlags)

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

impl BitXor for TypeFlags

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

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

type Output = TypeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for TypeFlags

fn bitxor_assign(&mut self, other: TypeFlags)

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

impl Clone for TypeFlags

fn clone(&self) -> TypeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeFlags

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TypeFlags

fn deserialize<__D>( __deserializer: __D ) -> Result<TypeFlags, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<TypeFlags> for TypeFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = TypeFlags>,

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

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 Flags for TypeFlags

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

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> TypeFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

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

Convert from a bits value.

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

Convert from a bits value, unsetting any unknown bits.

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

Get a flags value with the bits of a flag with the given name set.

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

Yield a set of contained flags values.

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

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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.

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.

fn insert(&mut self, other: Self)

where Self: Sized,

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

fn remove(&mut self, other: Self)

where Self: Sized,

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

fn toggle(&mut self, other: Self)

where Self: Sized,

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

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.

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

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

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

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

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

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

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

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

fn complement(self) -> Self

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

impl FromIterator<TypeFlags> for TypeFlags

fn from_iter<T>(iterator: T) -> TypeFlags

where T: IntoIterator<Item = TypeFlags>,

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

impl IntoIterator for TypeFlags

type Item = TypeFlags

The type of the elements being iterated over.

type IntoIter = Iter<TypeFlags>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for TypeFlags

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

Formats the value using the given formatter.

impl Not for TypeFlags

fn not(self) -> TypeFlags

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

type Output = TypeFlags

The resulting type after applying the ! operator.

impl Octal for TypeFlags

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

Formats the value using the given formatter.

impl PartialEq for TypeFlags

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

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

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.

impl Serialize for TypeFlags

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for TypeFlags

fn sub(self, other: TypeFlags) -> TypeFlags

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 = TypeFlags

The resulting type after applying the - operator.

impl SubAssign for TypeFlags

fn sub_assign(&mut self, other: TypeFlags)

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.

impl UpperHex for TypeFlags

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

Formats the value using the given formatter.

impl Copy for TypeFlags

impl Eq for TypeFlags

impl StructuralEq for TypeFlags

impl StructuralPartialEq for TypeFlags