Struct vulkano::descriptor_set::layout::DescriptorBindingFlags

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

Flags that control how a binding in a descriptor set layout is created.

Implementations

impl DescriptorBindingFlags

pub const UPDATE_AFTER_BIND: Self = _

Allows descriptors in this binding to be updated after a command buffer has already recorded a bind command containing a descriptor set with this layout, as long as the command buffer is not executing. Each descriptor can also be updated concurrently.

If a binding has this flag, then the descriptor set layout must be created with the DescriptorSetLayoutCreateFlags::UPDATE_AFTER_BIND_POOL flag, and descriptor sets using it must be allocated from a descriptor pool that has the DescriptorPoolCreateFlags::UPDATE_AFTER_BIND flag. In addition, the descriptor_binding_*_update_after_bind feature corresponding to the descriptor type of the binding must be enabled.

pub const UPDATE_UNUSED_WHILE_PENDING: Self = _

Allows descriptors in this binding to be updated after a command buffer has already recorded a bind command containing a descriptor set with this layout, as long as the command buffer is not executing, and no shader invocation recorded in the command buffer uses the descriptor. Each descriptor can also be updated concurrently.

This is a subset of what is allowed by DescriptorBindingFlags::UPDATE_AFTER_BIND, but has much less strict requirements. It does not require any additional flags to be present on the descriptor set layout or the descriptor pool, and instead requires the descriptor_binding_update_unused_while_pending feature.

What counts as “used” depends on whether the DescriptorBindingFlags::PARTIALLY_BOUND flag is also set. If it is set, then only dynamic use by a shader invocation counts as being used, otherwise all static use by a shader invocation is considered used.

pub const PARTIALLY_BOUND: Self = _

Allows descriptors to be left empty or invalid even if they are statically used by a shader invocation, as long as they are not dynamically used . Additionally, if DescriptorBindingFlags::UPDATE_UNUSED_WHILE_PENDING is set, allows updating descriptors if they are statically used by a command buffer they are recorded in, as long as are not dynamically used.

The descriptor_binding_partially_bound feature must be enabled on the device.

pub const VARIABLE_DESCRIPTOR_COUNT: Self = _

Whether the binding has a variable number of descriptors.

If set, the descriptor_binding_variable_descriptor_count feature must be enabled. The value of descriptor_count specifies the maximum number of descriptors allowed.

There may only be one binding with a variable count in a descriptor set, and it must be the binding with the highest binding number. The descriptor_type must not be DescriptorType::UniformBufferDynamic or DescriptorType::StorageBufferDynamic.

pub const fn empty() -> Self

Returns a DescriptorBindingFlags with none of the flags set.

pub const fn none() -> Self

👎Deprecated since 0.31.0: use empty instead

Returns a DescriptorBindingFlags with none of the flags set.

pub const fn count(self) -> u32

Returns the number of flags set in self.

pub const fn is_empty(self) -> bool

Returns whether no flags are set in self.

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

Returns whether any flags are set in both self and other.

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

Returns whether all flags in other are set in self.

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

Returns the union of self and other.

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

Returns the intersection of self and other.

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

Returns self without the flags set in other.

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

Returns the flags that are set in self or other, but not in both.

Trait Implementations

impl BitAnd for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl BitAndAssign for DescriptorBindingFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitOrAssign for DescriptorBindingFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl BitXorAssign for DescriptorBindingFlags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for DescriptorBindingFlags

fn clone(&self) -> DescriptorBindingFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptorBindingFlags

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

Formats the value using the given formatter.

impl Default for DescriptorBindingFlags

fn default() -> Self

Returns the “default value” for a type.

impl From<DescriptorBindingFlags> for DescriptorBindingFlags

fn from(val: DescriptorBindingFlags) -> Self

Converts to this type from the input type.

impl From<DescriptorBindingFlags> for DescriptorBindingFlags

fn from(val: DescriptorBindingFlags) -> Self

Converts to this type from the input type.

impl Hash for DescriptorBindingFlags

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for DescriptorBindingFlags

type Output = DescriptorBindingFlags

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl SubAssign for DescriptorBindingFlags

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for DescriptorBindingFlags

impl Eq for DescriptorBindingFlags

impl StructuralEq for DescriptorBindingFlags

impl StructuralPartialEq for DescriptorBindingFlags