Struct vulkano::descriptor_set::builder::DescriptorSetBuilder

pub struct DescriptorSetBuilder { /* fields omitted */ }

A builder for constructing a new descriptor set.

Implementations

impl DescriptorSetBuilder

pub fn start(layout: Arc<DescriptorSetLayout>) -> Self

Starts the process of building a descriptor set. Returns a builder.

Panic

• Panics if the set id is out of range.

pub fn build(self) -> Result<DescriptorSetBuilderOutput, DescriptorSetError>

Finalizes the building process and returns the generated output.

pub fn enter_array(&mut self) -> Result<&mut Self, DescriptorSetError>

Call this function if the next element of the set is an array in order to set the value of each element.

This function can be called even if the descriptor isn’t an array, and it is valid to enter the “array”, add one element, then leave.

pub fn leave_array(&mut self) -> Result<&mut Self, DescriptorSetError>

Leaves the array. Call this once you added all the elements of the array.

pub fn add_empty(&mut self) -> Result<&mut Self, DescriptorSetError>

Skips the current descriptor if it is empty.

pub fn add_buffer(
    &mut self,
    buffer: Arc<dyn BufferAccess>
) -> Result<&mut Self, DescriptorSetError>

Binds a buffer as the next descriptor or array element.

pub fn add_buffer_view<B>(
    &mut self,
    view: Arc<BufferView<B>>
) -> Result<&mut Self, DescriptorSetError> where
    B: BufferAccess + 'static, 

Binds a buffer view as the next descriptor or array element.

pub fn add_image(
    &mut self,
    image_view: Arc<dyn ImageViewAbstract>
) -> Result<&mut Self, DescriptorSetError>

Binds an image view as the next descriptor or array element.

pub fn add_sampled_image(
    &mut self,
    image_view: Arc<dyn ImageViewAbstract>,
    sampler: Arc<Sampler>
) -> Result<&mut Self, DescriptorSetError>

Binds an image view with a sampler as the next descriptor or array element.

If the descriptor set layout contains immutable samplers for this descriptor, use add_image instead.

pub fn add_sampler(
    &mut self,
    sampler: Arc<Sampler>
) -> Result<&mut Self, DescriptorSetError>

Binds a sampler as the next descriptor or array element.

Trait Implementations

impl DeviceOwned for DescriptorSetBuilder

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

Returns the device that owns Self.