Enum rafx_api::RafxPipeline

pub enum RafxPipeline {
    Empty(RafxPipelineEmpty),
}

Represents a complete GPU configuration for executing work.

There are two kinds of pipelines: Graphics and Compute

A pipeline includes fixed-function state (i.e. configuration) and programmable state (i.e. shaders). Pipelines are expensive objects to create. Ideally, they should be created when the application initializes or on a separate thread.

Pipelines are bound by command buffers. Fewer pipeline changes is better, and it is often worth batching draw calls that use the same pipeline to happen together so that the pipeline does not need to be changed as frequently.

Pipelines must not be dropped if they are in use by the GPU.

Variants

Empty(RafxPipelineEmpty)

Implementations

impl RafxPipeline

pub fn pipeline_type(&self) -> RafxPipelineType

Returns the type of pipeline that this is

pub fn root_signature(&self) -> &RafxRootSignature

Returns the root signature used to create the pipeline

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

Sets a name for this pipeline. This is useful for debugging, graphics debuggers/profilers such as nsight graphics or renderdoc will display this pipeline with the given name in the list of resources.

WARNING: Metal doesn’t support specifying debug names after pipeline creation, so it’s better to provide a debug_name in RafxGraphicsPipelineDef/RafxComputePipelineDef

pub fn empty_pipeline(&self) -> Option<&RafxPipelineEmpty>

Trait Implementations

impl Debug for RafxPipeline

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

Formats the value using the given formatter.