Struct vulkano::descriptor_set::layout::DescriptorSetDesc

pub struct DescriptorSetDesc { /* fields omitted */ }

Implementations

impl DescriptorSetDesc

pub fn new<I>(descriptors: I) -> Self where
    I: IntoIterator<Item = Option<DescriptorDesc>>, 

Builds a new DescriptorSetDesc with the given descriptors.

The descriptors must be passed in the order of the bindings. In order words, descriptor at bind point 0 first, then descriptor at bind point 1, and so on. If a binding must remain empty, you can make the iterator yield None for an element.

pub fn from_requirements<'a>(
    descriptor_requirements: impl IntoIterator<Item = ((u32, u32), &'a DescriptorRequirements)>
) -> Vec<Self>

Builds a list of DescriptorSetDesc from an iterator of DescriptorRequirement originating from a shader.

pub fn empty() -> DescriptorSetDesc

Builds a new empty DescriptorSetDesc.

pub fn bindings(&self) -> &[Option<DescriptorDesc>]

Returns the descriptors in the set.

pub fn descriptor(&self, num: u32) -> Option<&DescriptorDesc>

Returns the descriptor with the given binding number, or None if the binding is empty.

pub fn is_push_descriptor(&self) -> bool

Returns whether the description is set to be a push descriptor.

pub fn set_buffer_dynamic(&mut self, binding_num: u32)

Changes a buffer descriptor’s type to dynamic.

Panics

• Panics if the description is set to be a push descriptor.
• Panics if binding_num does not refer to a StorageBuffer or UniformBuffer descriptor.

pub fn set_immutable_samplers(
    &mut self,
    binding_num: u32,
    samplers: impl IntoIterator<Item = Arc<Sampler>>
)

Sets the immutable samplers for a sampler or combined image sampler descriptor.

Panics

• Panics if the binding number does not refer to a sampler or combined image sampler descriptor.

pub fn set_push_descriptor(&mut self, enabled: bool)

Sets the descriptor set layout to use push descriptors instead of descriptor sets.

If set to enabled, the khr_push_descriptor extension must be enabled on the device.

Panics

• If enabled, panics if the description contains a dynamic buffer descriptor.

pub fn set_variable_descriptor_count(
    &mut self,
    binding_num: u32,
    descriptor_count: u32
)

Sets the descriptor count for a descriptor that has a variable count.

pub fn is_compatible_with(&self, other: &DescriptorSetDesc) -> bool

Returns whether self is compatible with other.

“Compatible” in this sense is defined by the Vulkan specification under the section “Pipeline layout compatibility”: the two must be identically defined to the Vulkan API, meaning that all descriptors are compatible and flags are identical.

Trait Implementations

impl Clone for DescriptorSetDesc

fn clone(&self) -> DescriptorSetDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptorSetDesc

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

Formats the value using the given formatter.

impl Default for DescriptorSetDesc

fn default() -> DescriptorSetDesc

Returns the “default value” for a type.

impl<I> From<I> for DescriptorSetDesc where
    I: IntoIterator<Item = Option<DescriptorDesc>>, 

fn from(val: I) -> Self

Performs the conversion.