Struct vulkano::descriptor::descriptor_set::PersistentDescriptorSet

pub struct PersistentDescriptorSet<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 explicitly. 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

Implementations

impl PersistentDescriptorSet<()>

pub fn start(
    layout: Arc<UnsafeDescriptorSetLayout>
) -> PersistentDescriptorSetBuilder<()>

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

Panic

• Panics if the set id is out of range.

Trait Implementations

impl<R, P> DescriptorSet for PersistentDescriptorSet<R, P> where
    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<(&dyn 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<(&dyn ImageViewAbstract, 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<R, P> DescriptorSetDesc for PersistentDescriptorSet<R, P>

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>

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

Returns the device that owns Self.

impl<R, P> Hash for PersistentDescriptorSet<R, P> where
    P: DescriptorPoolAlloc,
    R: PersistentDescriptorSetResources, 

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, 

Feeds a slice of this type into the given Hasher.

impl<R, P> PartialEq<PersistentDescriptorSet<R, P>> for PersistentDescriptorSet<R, P> where
    P: DescriptorPoolAlloc,
    R: PersistentDescriptorSetResources, 

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

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

#[must_use]

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

This method tests for !=.

impl<R, P> Eq for PersistentDescriptorSet<R, P> where
    P: DescriptorPoolAlloc,
    R: PersistentDescriptorSetResources,