Struct screen_13::driver::compute::ComputePipeline

pub struct ComputePipeline {
    pub info: ComputePipelineInfo,
    /* 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.

Implementations

impl ComputePipeline

pub fn create(
    device: &Arc<Device>,
    info: impl Into<ComputePipelineInfo>
) -> 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 info = ComputePipelineInfo::new(my_shader_code.as_slice());
let pipeline = ComputePipeline::create(&device, info)?;

assert_ne!(*pipeline, vk::Pipeline::null());
assert_eq!(pipeline.info.entry_name.as_str(), "main");

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.