Struct GraphicsPipeline 

pub struct GraphicsPipeline { /* private fields */ }

Opaque representation of a pipeline object.

Also contains information about the object.

See VkPipeline.

Implementations

impl GraphicsPipeline

pub fn create<S>( device: &Device, info: impl Into<GraphicsPipelineInfo>, shaders: impl IntoIterator<Item = S>, ) -> Result<Self, DriverError>

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

Creates a new graphics pipeline on the given device.

The correct pipeline stages will be enabled based on the provided shaders. See Shader for details on all available stages.

See VkGraphicsPipelineCreateInfo.

shaders may contain pre-built Shader values or any inputs that can be converted into them. Invalid shader data is returned as DriverError::InvalidData through the Result instead of panicking.

Examples

Basic usage:

// shader code is raw SPIR-V code as bytes
let vert = Shader::new_vertex(my_vert_code.as_slice());
let frag = Shader::new_fragment(my_frag_code.as_slice());
let info = GraphicsPipelineInfo::default();
let pipeline = GraphicsPipeline::create(&device, info, [vert, frag])?;

assert_eq!(pipeline.info().front_face, vk::FrontFace::COUNTER_CLOCKWISE);

pub fn device(&self) -> &Device

The device which owns this graphics pipeline.

pub fn info(&self) -> GraphicsPipelineInfo

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.

Note: The name of the underlying Vulkan pipeline is lazily updated as submissions are recorded.

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

Sets the debugging name assigned to this pipeline.

Trait Implementations

impl Clone for GraphicsPipeline

fn clone(&self) -> GraphicsPipeline

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphicsPipeline

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

Formats the value using the given formatter.

impl Eq for GraphicsPipeline

impl Hash for GraphicsPipeline

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 GraphicsPipeline

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 GraphicsPipeline

type Command = PipelineCommand<'a, GraphicsPipeline>

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 GraphicsPipeline

type Command = PipelineCommand<'a, GraphicsPipeline>

The resource reference type.

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

Binds the resource to a command.