Struct wgpu::RenderPipelineDescriptor

pub struct RenderPipelineDescriptor<'a> {
    pub label: Label<'a>,
    pub layout: Option<&'a PipelineLayout>,
    pub vertex: VertexState<'a>,
    pub primitive: PrimitiveState,
    pub depth_stencil: Option<DepthStencilState>,
    pub multisample: MultisampleState,
    pub fragment: Option<FragmentState<'a>>,
    pub multiview: Option<NonZeroU32>,
    pub cache: Option<&'a PipelineCache>,
}

Describes a render (graphics) pipeline.

For use with Device::create_render_pipeline.

Corresponds to WebGPU GPURenderPipelineDescriptor.

Fields

label: Label<'a>

Debug label of the pipeline. This will show up in graphics debuggers for easy identification.

layout: Option<&'a PipelineLayout>

The layout of bind groups for this pipeline.

If this is set, then Device::create_render_pipeline will raise a validation error if the layout doesn’t match what the shader module(s) expect.

Using the same PipelineLayout for many RenderPipeline or ComputePipeline pipelines guarantees that you don’t have to rebind any resources when switching between those pipelines.

Default pipeline layout

If layout is None, then the pipeline has a default layout created and used instead. The default layout is deduced from the shader modules.

You can use RenderPipeline::get_bind_group_layout to create bind groups for use with the default layout. However, these bind groups cannot be used with any other pipelines. This is convenient for simple pipelines, but using an explicit layout is recommended in most cases.

vertex: VertexState<'a>

The compiled vertex stage, its entry point, and the input buffers layout.

primitive: PrimitiveState

The properties of the pipeline at the primitive assembly and rasterization level.

depth_stencil: Option<DepthStencilState>

The effect of draw calls on the depth and stencil aspects of the output target, if any.

multisample: MultisampleState

The multi-sampling properties of the pipeline.

fragment: Option<FragmentState<'a>>

The compiled fragment stage, its entry point, and the color targets.

multiview: Option<NonZeroU32>

If the pipeline will be used with a multiview render pass, this indicates how many array layers the attachments will have.

cache: Option<&'a PipelineCache>

The pipeline cache to use when creating this pipeline.

Trait Implementations

impl<'a> Clone for RenderPipelineDescriptor<'a>

fn clone(&self) -> RenderPipelineDescriptor<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RenderPipelineDescriptor<'a>

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

Formats the value using the given formatter.