Struct screen_13::driver::compute::ComputePipeline

pub struct ComputePipeline {
    pub info: ComputePipelineInfo,
    pub name: Option<String>,
    /* private fields */
}

Smart pointer handle to a pipeline object.

Also contains information about the object.

Deref behavior

ComputePipeline automatically dereferences to vk::Pipeline (via the Deref trait), so you can call vk::Pipeline’s methods on a value of type ComputePipeline.

Fields

info: ComputePipelineInfo

Information used to create this object.

name: Option<String>

A descriptive name used in debugging messages.

Implementations

impl ComputePipeline

pub fn create( device: &Arc<Device>, info: impl Into<ComputePipelineInfo>, shader: impl Into<Shader> ) -> Result<Self, DriverError>

Creates a new compute pipeline on the given device.

Panics

If shader code is not a multiple of four bytes.

Examples

Basic usage:

// my_shader_code is raw SPIR-V code as bytes
let shader = Shader::new_compute(my_shader_code.as_slice());
let pipeline = ComputePipeline::create(&device, ComputePipelineInfo::default(), shader)?;

assert_ne!(*pipeline, vk::Pipeline::null());

pub fn with_name(this: Self, name: impl Into<String>) -> Self

Sets the debugging name assigned to this pipeline.

Trait Implementations

impl Access for ComputePipeline

const DEFAULT_READ: AccessType = AccessType::ComputeShaderReadSampledImageOrUniformTexelBuffer

The default AccessType for read operations, if not specified explicitly.

const DEFAULT_WRITE: AccessType = AccessType::ComputeShaderWrite

The default AccessType for write operations, if not specified explicitly.

impl Debug for ComputePipeline

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

Formats the value using the given formatter.

impl Deref for ComputePipeline

type Target = Pipeline

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for ComputePipeline

fn drop(&mut self)

Executes the destructor for this type.