Struct wgpu::naga::valid::TypeFlags

source ·
pub struct TypeFlags(/* private fields */);
Expand description

Flags associated with Types by Validator.

Implementations§

source§

impl TypeFlags

source

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.

source

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.

source

pub const COPY: TypeFlags = _

The data can be copied around.

source

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.

source

pub const HOST_SHAREABLE: TypeFlags = _

Can be used for host-shareable structures.

source

pub const ARGUMENT: TypeFlags = _

This type can be passed as a function argument.

source

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.

source§

impl TypeFlags

source

pub const fn empty() -> TypeFlags

Get a flags value with all bits unset.

source

pub const fn all() -> TypeFlags

Get a flags value with all known bits set.

source

pub const fn bits(&self) -> u8

Get the underlying bits value.

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

source

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.

source

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

Convert from a bits value, unsetting any unknown bits.

source

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

Convert from a bits value exactly.

source

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.

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: TypeFlags) -> 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: TypeFlags) -> 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: TypeFlags)

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

source

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.

source

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

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

source

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

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

source

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

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

source

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

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

source

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.

source

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

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

source

pub const fn complement(self) -> TypeFlags

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

source§

impl TypeFlags

source

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.

source

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§

source§

impl Binary for TypeFlags

source§

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

Formats the value using the given formatter.
source§

impl BitAnd for TypeFlags

source§

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

impl BitAndAssign for TypeFlags

source§

fn bitand_assign(&mut self, other: TypeFlags)

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

source§

impl BitOr for TypeFlags

source§

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

impl BitOrAssign for TypeFlags

source§

fn bitor_assign(&mut self, other: TypeFlags)

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

source§

impl BitXor for TypeFlags

source§

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

impl BitXorAssign for TypeFlags

source§

fn bitxor_assign(&mut self, other: TypeFlags)

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

source§

impl Clone for TypeFlags

source§

fn clone(&self) -> TypeFlags

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 TypeFlags

source§

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

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

impl Extend<TypeFlags> for TypeFlags

source§

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

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 TypeFlags

source§

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

The set of defined flags.
§

type Bits = u8

The underlying bits type.
source§

fn bits(&self) -> u8

Get the underlying bits value. Read more
source§

fn from_bits_retain(bits: u8) -> TypeFlags

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

source§

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

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

source§

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

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

Creates an iterator from a value. Read more
source§

impl LowerHex for TypeFlags

source§

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

Formats the value using the given formatter.
source§

impl Not for TypeFlags

source§

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

impl Octal for TypeFlags

source§

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

Formats the value using the given formatter.
source§

impl PartialEq for TypeFlags

source§

fn eq(&self, other: &TypeFlags) -> 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 TypeFlags

source§

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

impl SubAssign for TypeFlags

source§

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.

source§

impl UpperHex for TypeFlags

source§

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

Formats the value using the given formatter.
source§

impl Copy for TypeFlags

source§

impl Eq for TypeFlags

source§

impl StructuralEq for TypeFlags

source§

impl StructuralPartialEq for TypeFlags

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,