Struct wgpu::ShaderFlags

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

Flags controlling the shader processing.

Note: These flags are internal tweaks, they don't affect the API.

Implementations

impl ShaderFlags

pub const VALIDATION: ShaderFlags

If enabled, wgpu will parse the shader with Naga and validate it both internally and with regards to the given pipeline interface.

pub const EXPERIMENTAL_TRANSLATION: ShaderFlags

If enabled, wgpu will attempt to operate on Naga's internal representation of the shader module for both validation and translation into the backend shader language, on backends where gfx-hal supports this.

pub const fn empty() -> ShaderFlags

Returns an empty set of flags

pub const fn all() -> ShaderFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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) -> ShaderFlags

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

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

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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: ShaderFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ShaderFlags

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

Formats the value using the given formatter.

impl BitAnd<ShaderFlags> for ShaderFlags

type Output = ShaderFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ShaderFlags> for ShaderFlags

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

Disables all flags disabled in the set.

impl BitOr<ShaderFlags> for ShaderFlags

type Output = ShaderFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<ShaderFlags> for ShaderFlags

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

Adds the set of flags.

impl BitXor<ShaderFlags> for ShaderFlags

type Output = ShaderFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ShaderFlags> for ShaderFlags

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

Toggles the set of flags.

impl Clone for ShaderFlags

pub fn clone(&self) -> ShaderFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ShaderFlags

impl Debug for ShaderFlags

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

Formats the value using the given formatter.

impl Default for ShaderFlags

pub fn default() -> ShaderFlags

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for ShaderFlags

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

Deserialize this value from the given Serde deserializer.

impl Eq for ShaderFlags

impl Extend<ShaderFlags> for ShaderFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<ShaderFlags> for ShaderFlags

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

Creates a value from an iterator.

impl Hash for ShaderFlags

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

Feeds this value into the given Hasher.

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

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

Formats the value using the given formatter.

impl Not for ShaderFlags

type Output = ShaderFlags

The resulting type after applying the ! operator.

pub fn not(self) -> ShaderFlags

Returns the complement of this set of flags.

impl Octal for ShaderFlags

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

Formats the value using the given formatter.

impl Ord for ShaderFlags

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ShaderFlags> for ShaderFlags

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

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

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

This method tests for !=.

impl PartialOrd<ShaderFlags> for ShaderFlags

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

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

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

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

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

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

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

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

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

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

impl Serialize for ShaderFlags

pub 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 StructuralEq for ShaderFlags

impl StructuralPartialEq for ShaderFlags

impl Sub<ShaderFlags> for ShaderFlags

type Output = ShaderFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ShaderFlags> for ShaderFlags

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

Disables all flags enabled in the set.

impl UpperHex for ShaderFlags

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

Formats the value using the given formatter.