Struct vulkano::pipeline::GraphicsPipeline

pub struct GraphicsPipeline<VertexDefinition, Layout> { /* fields omitted */ }

Defines how the implementation should perform a draw operation.

This object contains the shaders and the various fixed states that describe how the implementation should perform the various operations needed by a draw command.

Implementations

impl GraphicsPipeline<(), ()>

pub fn start<'a>(
) -> GraphicsPipelineBuilder<BufferlessDefinition, EmptyEntryPointDummy, (), EmptyEntryPointDummy, (), EmptyEntryPointDummy, (), EmptyEntryPointDummy, (), EmptyEntryPointDummy, ()>

Starts the building process of a graphics pipeline. Returns a builder object that you can fill with the various parameters.

impl<Mv, L> GraphicsPipeline<Mv, L>

pub fn vertex_definition(&self) -> &Mv

Returns the vertex definition used in the constructor.

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

Returns the device used to create this pipeline.

impl<Mv, L> GraphicsPipeline<Mv, L> where
    L: PipelineLayoutAbstract, 

pub fn layout(&self) -> &L

Returns the pipeline layout used in the constructor.

impl<Mv, L> GraphicsPipeline<Mv, L>

pub fn subpass(&self) -> Subpass

Returns the pass used in the constructor.

impl<Mv, L> GraphicsPipeline<Mv, L>

pub fn render_pass(&self) -> &Arc<RenderPass>

Returns the render pass used in the constructor.

pub fn has_dynamic_line_width(&self) -> bool

Returns true if the line width used by this pipeline is dynamic.

pub fn num_viewports(&self) -> u32

Returns the number of viewports and scissors of this pipeline.

pub fn has_dynamic_viewports(&self) -> bool

Returns true if the viewports used by this pipeline are dynamic.

pub fn has_dynamic_scissors(&self) -> bool

Returns true if the scissors used by this pipeline are dynamic.

pub fn has_dynamic_depth_bounds(&self) -> bool

Returns true if the depth bounds used by this pipeline are dynamic.

pub fn has_dynamic_stencil_compare_mask(&self) -> bool

Returns true if the stencil compare masks used by this pipeline are dynamic.

pub fn has_dynamic_stencil_write_mask(&self) -> bool

Returns true if the stencil write masks used by this pipeline are dynamic.

pub fn has_dynamic_stencil_reference(&self) -> bool

Returns true if the stencil references used by this pipeline are dynamic.

Trait Implementations

impl<Mv, L> Debug for GraphicsPipeline<Mv, L>

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

Formats the value using the given formatter.

impl<Mv, L> DeviceOwned for GraphicsPipeline<Mv, L>

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

Returns the device that owns Self.

impl<Mv, L> GraphicsPipelineAbstract for GraphicsPipeline<Mv, L> where
    L: PipelineLayoutAbstract,
    Mv: VertexSource<Vec<Arc<dyn BufferAccess + Send + Sync>>>, 

fn inner(&self) -> GraphicsPipelineSys<'_>

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

fn subpass(&self) -> &Subpass

Returns the subpass this graphics pipeline is rendering to.

fn has_dynamic_line_width(&self) -> bool

Returns true if the line width used by this pipeline is dynamic.

fn num_viewports(&self) -> u32

Returns the number of viewports and scissors of this pipeline.

fn has_dynamic_viewports(&self) -> bool

Returns true if the viewports used by this pipeline are dynamic.

fn has_dynamic_scissors(&self) -> bool

Returns true if the scissors used by this pipeline are dynamic.

fn has_dynamic_depth_bounds(&self) -> bool

Returns true if the depth bounds used by this pipeline are dynamic.

fn has_dynamic_stencil_compare_mask(&self) -> bool

Returns true if the stencil compare masks used by this pipeline are dynamic.

fn has_dynamic_stencil_write_mask(&self) -> bool

Returns true if the stencil write masks used by this pipeline are dynamic.

fn has_dynamic_stencil_reference(&self) -> bool

Returns true if the stencil references used by this pipeline are dynamic.

impl<Mv, L> Hash for GraphicsPipeline<Mv, L> where
    L: PipelineLayoutAbstract,
    Mv: VertexSource<Vec<Arc<dyn BufferAccess + Send + Sync>>>, 

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, 

Feeds a slice of this type into the given Hasher.

impl<Mv, L> PartialEq<GraphicsPipeline<Mv, L>> for GraphicsPipeline<Mv, L> where
    L: PipelineLayoutAbstract,
    Mv: VertexSource<Vec<Arc<dyn BufferAccess + Send + Sync>>>, 

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<Mv, L> PipelineLayoutAbstract for GraphicsPipeline<Mv, L> where
    L: PipelineLayoutAbstract, 

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

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

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

Returns the UnsafeDescriptorSetLayout object of the specified set index.

impl<Mv, L> PipelineLayoutDesc for GraphicsPipeline<Mv, L> where
    L: PipelineLayoutDesc, 

fn num_sets(&self) -> usize

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

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

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

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

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

fn num_push_constants_ranges(&self) -> usize

Returns the number of push constant ranges of the layout.

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

Returns a description of the given push constants range.

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.

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

Builds the union of this layout and another.

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

Checks whether this description fulfills the device limits requirements.

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<Mv, L, I> VertexDefinition<I> for GraphicsPipeline<Mv, L> where
    Mv: VertexDefinition<I>, 

type BuffersIter = <Mv as VertexDefinition<I>>::BuffersIter

Iterator that returns the offset, the stride (in bytes) and input rate of each buffer.

type AttribsIter = <Mv as VertexDefinition<I>>::AttribsIter

Iterator that returns the attribute location, buffer id, and infos.

fn definition(
    &self,
    interface: &I
) -> Result<(Self::BuffersIter, Self::AttribsIter), IncompatibleVertexDefinitionError>

Builds the vertex definition to use to link this definition to a vertex shader’s input interface.

impl<Mv, L, S> VertexSource<S> for GraphicsPipeline<Mv, L> where
    Mv: VertexSource<S>, 

fn decode(
    &self,
    s: S
) -> (Vec<Box<dyn BufferAccess + Send + Sync>>, usize, usize)

Checks and returns the list of buffers with offsets, number of vertices and number of instances.

impl<Mv, L> VulkanObject for GraphicsPipeline<Mv, L>

type Object = Pipeline

The type of the object.

const TYPE: ObjectType

The ObjectType of the internal Vulkan handle.

fn internal_object(&self) -> Pipeline

Returns a reference to the object.

impl<Mv, L> Eq for GraphicsPipeline<Mv, L> where
    L: PipelineLayoutAbstract,
    Mv: VertexSource<Vec<Arc<dyn BufferAccess + Send + Sync>>>,