Struct vulkano::descriptor::descriptor_set::PersistentDescriptorSet

pub struct PersistentDescriptorSet<L, R, P = StdDescriptorPoolAlloc> { /* fields omitted */ }

An immutable descriptor set that is expected to be long-lived.

Creating a persistent descriptor set allocates from a pool, and can't be modified once created. You are therefore encouraged to create them at initialization and not the during performance-critical paths.

Note: You can control of the pool that is used to create the descriptor set, if you wish so. By creating a implementation of the DescriptorPool trait that doesn't perform any actual allocation, you can skip this allocation and make it acceptable to use a persistent descriptor set in performance-critical paths..

The template parameter of the PersistentDescriptorSet is complex, and you shouldn't try to express it explicitely. If you want to store your descriptor set in a struct or in a Vec for example, you are encouraged to turn the PersistentDescriptorSet into a Box<DescriptorSet> or a Arc<DescriptorSet>.

Example

Methods

impl<L> PersistentDescriptorSet<L, ()>

fn start(layout: L, set_id: usize) -> PersistentDescriptorSetBuilder<L, ()> where
    L: PipelineLayoutAbstract, 

Starts the process of building a PersistentDescriptorSet. Returns a builder.

Panic

• Panics if the set id is out of range.

Trait Implementations

impl<L, R, P> DescriptorSet for PersistentDescriptorSet<L, R, P> where
    L: PipelineLayoutAbstract,
    P: DescriptorPoolAlloc,
    R: PersistentDescriptorSetResources, 

fn inner(&self) -> &UnsafeDescriptorSet

Returns the inner UnsafeDescriptorSet.

fn num_buffers(&self) -> usize

Returns the number of buffers within this descriptor set.

fn buffer(&self, index: usize) -> Option<(&BufferAccess, u32)>

Returns the indexth buffer of this descriptor set, or None if out of range. Also returns the index of the descriptor that uses this buffer.

fn num_images(&self) -> usize

Returns the number of images within this descriptor set.

fn image(&self, index: usize) -> Option<(&ImageViewAccess, u32)>

Returns the indexth image of this descriptor set, or None if out of range. Also returns the index of the descriptor that uses this image.

impl<L, R, P> DescriptorSetDesc for PersistentDescriptorSet<L, R, P> where
    L: PipelineLayoutAbstract, 

fn num_bindings(&self) -> usize

Returns the number of binding slots in the set.

fn descriptor(&self, binding: usize) -> Option<DescriptorDesc>

Returns a description of a descriptor, or None if out of range.

impl<R, P> DeviceOwned for PersistentDescriptorSet<R, P> where
    P: DeviceOwned, 

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.