Struct sierra::DescriptorBindingFlags
source · pub struct DescriptorBindingFlags { /* private fields */ }
Expand description
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§
source§impl DescriptorBindingFlags
impl DescriptorBindingFlags
sourcepub const UPDATE_AFTER_BIND: Self = _
pub const UPDATE_AFTER_BIND: Self = _
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.
sourcepub const PARTIALLY_BOUND: Self = _
pub const PARTIALLY_BOUND: Self = _
Allows descriptors that are not dynamically used by any shader invocation to be unbound.
sourcepub const UPDATE_UNUSED_WHILE_PENDING: Self = _
pub const UPDATE_UNUSED_WHILE_PENDING: Self = _
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.
sourcepub const VARIABLE_DESCRIPTOR_COUNT: Self = _
pub const VARIABLE_DESCRIPTOR_COUNT: Self = _
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.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
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§
source§impl Binary for DescriptorBindingFlags
impl Binary for DescriptorBindingFlags
source§impl BitAndAssign<DescriptorBindingFlags> for DescriptorBindingFlags
impl BitAndAssign<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<DescriptorBindingFlags> for DescriptorBindingFlags
impl BitOr<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn bitor(self, other: DescriptorBindingFlags) -> Self
fn bitor(self, other: DescriptorBindingFlags) -> Self
Returns the union of the two sets of flags.
§type Output = DescriptorBindingFlags
type Output = DescriptorBindingFlags
|
operator.source§impl BitOrAssign<DescriptorBindingFlags> for DescriptorBindingFlags
impl BitOrAssign<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<DescriptorBindingFlags> for DescriptorBindingFlags
impl BitXorAssign<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for DescriptorBindingFlags
impl Clone for DescriptorBindingFlags
source§fn clone(&self) -> DescriptorBindingFlags
fn clone(&self) -> DescriptorBindingFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DescriptorBindingFlags
impl Debug for DescriptorBindingFlags
source§impl Extend<DescriptorBindingFlags> for DescriptorBindingFlags
impl Extend<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<DescriptorBindingFlags> for DescriptorBindingFlags
impl FromIterator<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for DescriptorBindingFlags
impl Hash for DescriptorBindingFlags
source§impl LowerHex for DescriptorBindingFlags
impl LowerHex for DescriptorBindingFlags
source§impl Not for DescriptorBindingFlags
impl Not for DescriptorBindingFlags
source§impl Octal for DescriptorBindingFlags
impl Octal for DescriptorBindingFlags
source§impl Ord for DescriptorBindingFlags
impl Ord for DescriptorBindingFlags
source§fn cmp(&self, other: &DescriptorBindingFlags) -> Ordering
fn cmp(&self, other: &DescriptorBindingFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<DescriptorBindingFlags> for DescriptorBindingFlags
impl PartialEq<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn eq(&self, other: &DescriptorBindingFlags) -> bool
fn eq(&self, other: &DescriptorBindingFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<DescriptorBindingFlags> for DescriptorBindingFlags
impl PartialOrd<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn partial_cmp(&self, other: &DescriptorBindingFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &DescriptorBindingFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl SubAssign<DescriptorBindingFlags> for DescriptorBindingFlags
impl SubAssign<DescriptorBindingFlags> for DescriptorBindingFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.