Struct vulkano::pipeline::compute::ComputePipeline

pub struct ComputePipeline { /* fields omitted */ }

A pipeline object that describes to the Vulkan implementation how it should perform compute operations.

The template parameter contains the descriptor set to use with this pipeline.

Pass an optional Arc to a PipelineCache to enable pipeline caching. The vulkan implementation will handle the PipelineCache and check if it is available. Check the documentation of the PipelineCache for more information.

Implementations

impl ComputePipeline

pub fn new<Css, F>(
    device: Arc<Device>,
    shader: EntryPoint<'_>,
    specialization_constants: &Css,
    cache: Option<Arc<PipelineCache>>,
    func: F
) -> Result<Arc<ComputePipeline>, ComputePipelineCreationError> where
    Css: SpecializationConstants,
    F: FnOnce(&mut [DescriptorSetDesc]), 

Builds a new ComputePipeline.

func is a closure that is given a mutable reference to the inferred descriptor set definitions. This can be used to make changes to the layout before it’s created, for example to add dynamic buffers or immutable samplers.

pub fn with_pipeline_layout<Css>(
    device: Arc<Device>,
    shader: EntryPoint<'_>,
    specialization_constants: &Css,
    layout: Arc<PipelineLayout>,
    cache: Option<Arc<PipelineCache>>
) -> Result<Arc<ComputePipeline>, ComputePipelineCreationError> where
    Css: SpecializationConstants, 

Builds a new ComputePipeline with a specific pipeline layout.

An error will be returned if the pipeline layout isn’t a superset of what the shader uses.

pub unsafe fn with_unchecked_pipeline_layout<Css>(
    device: Arc<Device>,
    shader: EntryPoint<'_>,
    specialization_constants: &Css,
    layout: Arc<PipelineLayout>,
    cache: Option<Arc<PipelineCache>>
) -> Result<Arc<ComputePipeline>, ComputePipelineCreationError> where
    Css: SpecializationConstants, 

Same as with_pipeline_layout, but doesn’t check whether the pipeline layout is a superset of what the shader expects.

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

Returns the Device this compute pipeline was created with.

pub fn descriptor_requirements(
    &self
) -> impl ExactSizeIterator<Item = ((u32, u32), &DescriptorRequirements)>

Returns an iterator over the descriptor requirements for this pipeline.

Trait Implementations

impl Debug for ComputePipeline

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

Formats the value using the given formatter.

impl DeviceOwned for ComputePipeline

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

Returns the device that owns Self.

impl Drop for ComputePipeline

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<ComputePipeline> for ComputePipeline

fn eq(&self, other: &Self) -> 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 !=.

impl Pipeline for ComputePipeline

fn bind_point(&self) -> PipelineBindPoint

Returns the bind point of this pipeline.

fn layout(&self) -> &Arc<PipelineLayout>

Returns the pipeline layout used in this pipeline.

fn num_used_descriptor_sets(&self) -> u32

Returns the number of descriptor sets actually accessed by this pipeline. This may be less than the number of sets in the pipeline layout.

impl VulkanObject for ComputePipeline

type Object = Pipeline

The type of the object.

fn internal_object(&self) -> Pipeline

Returns a reference to the object.

impl Eq for ComputePipeline