Struct vulkano::pipeline::ComputePipeline

pub struct ComputePipeline<Pl> { /* 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<Pl>> 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>(
    device: Arc<Device>,
    shader: &Cs,
    specialization: &Cs::SpecializationConstants,
    cache: Option<Arc<PipelineCache>>
) -> Result<ComputePipeline<PipelineLayout<Cs::PipelineLayout>>, ComputePipelineCreationError> where
    Cs::PipelineLayout: Clone,
    Cs: EntryPointAbstract, 

Builds a new ComputePipeline.

impl<Pl> ComputePipeline<Pl>

pub fn with_pipeline_layout<Cs>(
    device: Arc<Device>,
    shader: &Cs,
    specialization: &Cs::SpecializationConstants,
    pipeline_layout: Pl,
    cache: Option<Arc<PipelineCache>>
) -> Result<ComputePipeline<Pl>, ComputePipelineCreationError> where
    Cs::PipelineLayout: Clone,
    Cs: EntryPointAbstract,
    Pl: PipelineLayoutAbstract, 

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>(
    device: Arc<Device>,
    shader: &Cs,
    specialization: &Cs::SpecializationConstants,
    pipeline_layout: Pl,
    cache: Option<Arc<PipelineCache>>
) -> Result<ComputePipeline<Pl>, ComputePipelineCreationError> where
    Cs::PipelineLayout: Clone,
    Cs: EntryPointAbstract,
    Pl: PipelineLayoutAbstract, 

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

impl<Pl> ComputePipeline<Pl>

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

Returns the Device this compute pipeline was created with.

pub fn layout(&self) -> &Pl

Returns the pipeline layout used in this compute pipeline.

Trait Implementations

impl<Pl> ComputePipelineAbstract for ComputePipeline<Pl> where
    Pl: PipelineLayoutAbstract, 

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

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

impl<Pl> Debug for ComputePipeline<Pl>

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

Formats the value using the given formatter.

impl<Pl> DeviceOwned for ComputePipeline<Pl>

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

Returns the device that owns Self.

impl<Pl> PipelineLayoutAbstract for ComputePipeline<Pl> where
    Pl: PipelineLayoutAbstract, 

pub fn sys(&self) -> PipelineLayoutSys<'_>

Returns an opaque object that allows internal access to the pipeline layout.

pub fn descriptor_set_layout(
    &self,
    index: usize
) -> Option<&Arc<UnsafeDescriptorSetLayout>>

Returns the UnsafeDescriptorSetLayout object of the specified set index.

impl<Pl> PipelineLayoutDesc for ComputePipeline<Pl> where
    Pl: PipelineLayoutDesc, 

pub fn num_sets(&self) -> usize

Returns the number of sets in the layout. Includes possibly empty sets.

pub fn num_bindings_in_set(&self, set: usize) -> Option<usize>

Returns the number of descriptors in the set. Includes possibly empty descriptors.

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

Returns the descriptor for the given binding of the given set.

pub fn num_push_constants_ranges(&self) -> usize

Returns the number of push constant ranges of the layout.

pub fn push_constants_range(
    &self,
    num: usize
) -> Option<PipelineLayoutDescPcRange>

Returns a description of the given push constants range.

pub fn provided_set_layout(
    &self,
    _set: usize
) -> Option<Arc<UnsafeDescriptorSetLayout>>

If the PipelineLayoutDesc implementation is able to provide an existing UnsafeDescriptorSetLayout for a given set, it can do so by returning it here.

pub fn union<T>(self, other: T) -> PipelineLayoutDescUnion<Self, T> where
    Self: Sized, 

Builds the union of this layout and another.

pub fn check_against_limits(
    &self,
    device: &Device
) -> Result<(), PipelineLayoutLimitsError>

Checks whether this description fulfills the device limits requirements.

pub fn build(
    self,
    device: Arc<Device>
) -> Result<PipelineLayout<Self>, PipelineLayoutCreationError> where
    Self: Sized, 

Turns the layout description into a PipelineLayout object that can be used by Vulkan.

impl<Pl> VulkanObject for ComputePipeline<Pl>

type Object = Pipeline

The type of the object.

pub const TYPE: ObjectType

The ObjectType of the internal Vulkan handle.

pub fn internal_object(&self) -> Pipeline

Returns a reference to the object.