Struct vulkano::pipeline::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.

All compute pipeline objects implement the ComputePipelineAbstract trait. You can turn any Arc<ComputePipeline> into an Arc<ComputePipelineAbstract> if necessary.

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<Cs, Css>(
    device: Arc<Device>,
    shader: &Cs,
    spec_constants: &Css,
    cache: Option<Arc<PipelineCache>>
) -> Result<ComputePipeline, ComputePipelineCreationError> where
    Cs: EntryPointAbstract,
    Css: SpecializationConstants, 

Builds a new ComputePipeline.

pub fn with_pipeline_layout<Cs, Css>(
    device: Arc<Device>,
    shader: &Cs,
    spec_constants: &Css,
    pipeline_layout: Arc<PipelineLayout>,
    cache: Option<Arc<PipelineCache>>
) -> Result<ComputePipeline, ComputePipelineCreationError> where
    Cs: EntryPointAbstract,
    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<Cs, Css>(
    device: Arc<Device>,
    shader: &Cs,
    spec_constants: &Css,
    pipeline_layout: Arc<PipelineLayout>,
    cache: Option<Arc<PipelineCache>>
) -> Result<ComputePipeline, ComputePipelineCreationError> where
    Cs: EntryPointAbstract,
    Css: SpecializationConstants, 

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

impl ComputePipeline

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

Returns the Device this compute pipeline was created with.

Trait Implementations

impl ComputePipelineAbstract for ComputePipeline

fn inner(&self) -> ComputePipelineSys<'_>

Returns an opaque object that represents the inside of the compute pipeline.

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

Returns the pipeline layout used in this compute pipeline.

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 VulkanObject for ComputePipeline

type Object = Pipeline

The type of the object.

fn internal_object(&self) -> Pipeline

Returns a reference to the object.