Struct sierra::DescriptorBindingFlags

pub struct DescriptorBindingFlags { /* fields omitted */ }

Flags that can be set in each DescriptorSetLayoutBinding to specify options for the corresponding descriptor set layout binding. Note that Vulkan 1.2 is required for any of these flags. That is, the only valid value prior Vulkan 1.2 is DescriptorBindingFlags::empty().

Implementations

impl DescriptorBindingFlags

pub const UPDATE_AFTER_BIND: DescriptorBindingFlags

Allows update binding after set is bound to encoder. Updating binding without this flag would invalidate encoder or built command buffer where set is used.

pub const UPDATE_UNUSED_WHILE_PENDING: DescriptorBindingFlags

Allows updating descriptors in this binding that are not used. while set is bound to pending command buffer.
i.e. when shader may access other descriptors in the set.

If DescriptorBindingFlags::PARTIALLY_BOUND is also set then descriptors that are not dynamically used by any shader invocation can be updated. Otherwise only descriptors that are not statically used by any shader invocation can be updated.

pub const PARTIALLY_BOUND: DescriptorBindingFlags

Allows descriptors that are not dynamically used by any shader invocation to be unbound.

pub const VARIABLE_DESCRIPTOR_COUNT: DescriptorBindingFlags

Binding with this flag does not have descriptors count defined by layout. Instead count is specified when set instance is created. Allowing sets with same layout to have differently sized arrays of descriptors bound to the binding.

pub const fn empty() -> DescriptorBindingFlags

Returns an empty set of flags

pub const fn all() -> DescriptorBindingFlags

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<DescriptorBindingFlags>

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for DescriptorBindingFlags

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

Formats the value using the given formatter.

impl BitAnd<DescriptorBindingFlags> for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<DescriptorBindingFlags> for DescriptorBindingFlags

fn bitand_assign(&mut self, other: DescriptorBindingFlags)

Disables all flags disabled in the set.

impl BitOr<DescriptorBindingFlags> for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<DescriptorBindingFlags> for DescriptorBindingFlags

fn bitor_assign(&mut self, other: DescriptorBindingFlags)

Adds the set of flags.

impl BitXor<DescriptorBindingFlags> for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<DescriptorBindingFlags> for DescriptorBindingFlags

fn bitxor_assign(&mut self, other: DescriptorBindingFlags)

Toggles the set of flags.

impl Clone for DescriptorBindingFlags

fn clone(&self) -> DescriptorBindingFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DescriptorBindingFlags

impl Debug for DescriptorBindingFlags

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

Formats the value using the given formatter.

impl Eq for DescriptorBindingFlags

impl Extend<DescriptorBindingFlags> for DescriptorBindingFlags

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

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

fn from_iter<T: IntoIterator<Item = DescriptorBindingFlags>>(
    iterator: T
) -> DescriptorBindingFlags

Creates a value from an iterator.

impl Hash for DescriptorBindingFlags

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

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 DescriptorBindingFlags

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

Formats the value using the given formatter.

impl Not for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the ! operator.

fn not(self) -> DescriptorBindingFlags

Returns the complement of this set of flags.

impl Octal for DescriptorBindingFlags

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

Formats the value using the given formatter.

impl Ord for DescriptorBindingFlags

fn cmp(&self, other: &DescriptorBindingFlags) -> 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<DescriptorBindingFlags> for DescriptorBindingFlags

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

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

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

This method tests for !=.

impl PartialOrd<DescriptorBindingFlags> for DescriptorBindingFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for DescriptorBindingFlags

impl StructuralPartialEq for DescriptorBindingFlags

impl Sub<DescriptorBindingFlags> for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<DescriptorBindingFlags> for DescriptorBindingFlags

fn sub_assign(&mut self, other: DescriptorBindingFlags)

Disables all flags enabled in the set.

impl UpperHex for DescriptorBindingFlags

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

Formats the value using the given formatter.