Struct ComputePipeline 

pub struct ComputePipeline { /* private fields */ }

Smart pointer handle of a compute pipeline object.

Also contains information about the object.

See VkPipeline.

Implementations

impl ComputePipeline

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

where S: TryInto<Shader>, S::Error: Into<DriverError>,

Creates a new compute pipeline on the given device.

shader may be a pre-built Shader or any input that can be converted into one. Invalid shader data is returned as DriverError::InvalidData through the Result instead of panicking.

See VkComputePipelineCreateInfo.

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.handle(), vk::Pipeline::null());

pub fn device(&self) -> &Device

The device which owns this compute pipeline.

pub fn handle(&self) -> Pipeline

The native Vulkan pipeline handle of this compute pipeline.

pub fn info(&self) -> ComputePipelineInfo

Gets the information used to create this object.

pub fn set_debug_name(&self, name: impl AsRef<str>)

Sets the debugging name assigned to this pipeline.

pub fn with_debug_name(self, name: impl AsRef<str>) -> Self

Sets the debugging name assigned to this pipeline.

Trait Implementations

impl Clone for ComputePipeline

fn clone(&self) -> ComputePipeline

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ComputePipeline

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

Formats the value using the given formatter.

impl Eq for ComputePipeline

impl Hash for ComputePipeline

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ComputePipeline

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Pipeline<'a> for ComputePipeline

type Command = PipelineCommand<'a, ComputePipeline>

The resource reference type.

fn bind_cmd(self, cmd: Command<'a>) -> Self::Command

Binds the resource to a command.

impl<'a> Pipeline<'a> for &'a ComputePipeline

type Command = PipelineCommand<'a, ComputePipeline>

The resource reference type.

fn bind_cmd(self, cmd: Command<'a>) -> Self::Command

Binds the resource to a command.