Struct nannou::wgpu::RenderPipelineBuilder

pub struct RenderPipelineBuilder<'a> { /* fields omitted */ }

A builder type to help simplify the construction of a RenderPipeline.

We've attempted to provide a suite of reasonable defaults in the case that none are provided.

Methods

impl<'a> RenderPipelineBuilder<'a>

pub const DEFAULT_SHADER_ENTRY_POINT: &'static str

pub const DEFAULT_FRONT_FACE: FrontFace

pub const DEFAULT_CULL_MODE: CullMode

pub const DEFAULT_DEPTH_BIAS: i32

pub const DEFAULT_DEPTH_BIAS_SLOPE_SCALE: f32

pub const DEFAULT_DEPTH_BIAS_CLAMP: f32

pub const DEFAULT_RASTERIZATION_STATE: RasterizationStateDescriptor

pub const DEFAULT_PRIMITIVE_TOPOLOGY: PrimitiveTopology

pub const DEFAULT_COLOR_FORMAT: TextureFormat

pub const DEFAULT_COLOR_BLEND: BlendDescriptor

pub const DEFAULT_ALPHA_BLEND: BlendDescriptor

pub const DEFAULT_COLOR_WRITE: ColorWrite

pub const DEFAULT_COLOR_STATE: ColorStateDescriptor

pub const DEFAULT_DEPTH_FORMAT: TextureFormat

pub const DEFAULT_DEPTH_WRITE_ENABLED: bool

pub const DEFAULT_DEPTH_COMPARE: CompareFunction

pub const DEFAULT_STENCIL_FRONT: StencilStateFaceDescriptor

pub const DEFAULT_STENCIL_BACK: StencilStateFaceDescriptor

pub const DEFAULT_STENCIL_READ_MASK: u32

pub const DEFAULT_STENCIL_WRITE_MASK: u32

pub const DEFAULT_DEPTH_STENCIL_STATE: DepthStencilStateDescriptor

pub const DEFAULT_INDEX_FORMAT: IndexFormat

pub const DEFAULT_SAMPLE_COUNT: u32

pub const DEFAULT_SAMPLE_MASK: u32

pub const DEFAULT_ALPHA_TO_COVERAGE_ENABLED: bool

pub fn from_layout(layout: &'a PipelineLayout, vs_mod: &'a ShaderModule) -> Self

Begin building the render pipeline for the given pipeline layout and the vertex shader module.

pub fn from_layout_descriptor<T>(
    layout_desc: T,
    vs_mod: &'a ShaderModule
) -> Self where
    T: IntoPipelineLayoutDescriptor<'a>, 

Begin building the render pipeline for a pipeline with the given layout descriptor and the vertex shader module.

pub fn vertex_entry_point(self, entry_point: &'a str) -> Self

pub fn fragment_entry_point(self, entry_point: &'a str) -> Self

pub fn fragment_shader(self, fs_mod: &'a ShaderModule) -> Self

Specify a fragment shader for the render pipeline.

pub fn rasterization_state(self, state: RasterizationStateDescriptor) -> Self

Specify the full rasterization state.

pub fn front_face(self, front_face: FrontFace) -> Self

pub fn cull_mode(self, cull_mode: CullMode) -> Self

pub fn depth_bias(self, bias: i32) -> Self

pub fn depth_bias_slope_scale(self, scale: f32) -> Self

pub fn depth_bias_clamp(self, clamp: f32) -> Self

pub fn primitive_topology(self, topology: PrimitiveTopology) -> Self

Specify the primitive topology.

This represents the way vertices will be read from the VertexBuffer.

pub fn color_state(self, state: ColorStateDescriptor) -> Self

Specify the full color state for drawing to the output attachment.

If you have multiple output attachments, see the color_states method.

pub fn color_format(self, format: TextureFormat) -> Self

pub fn color_blend(self, blend: BlendDescriptor) -> Self

pub fn alpha_blend(self, blend: BlendDescriptor) -> Self

pub fn write_mask(self, mask: ColorWrite) -> Self

pub fn depth_stencil_state(self, state: DepthStencilStateDescriptor) -> Self

pub fn depth_format(self, format: TextureFormat) -> Self

pub fn depth_write_enabled(self, enabled: bool) -> Self

pub fn depth_compare(self, compare: CompareFunction) -> Self

pub fn stencil_front(self, stencil: StencilStateFaceDescriptor) -> Self

pub fn stencil_back(self, stencil: StencilStateFaceDescriptor) -> Self

pub fn stencil_read_mask(self, mask: u32) -> Self

pub fn stencil_write_mask(self, mask: u32) -> Self

pub fn index_format(self, format: IndexFormat) -> Self

The format of the type used within the index buffer.

pub fn add_vertex_buffer_descriptor(
    self,
    d: VertexBufferDescriptor<'static>
) -> Self

Add a new vertex buffer descriptor to the render pipeline.

pub fn add_vertex_buffer<V>(self) -> Self where
    V: VertexDescriptor, 

Short-hand for adding a descriptor to the render pipeline describing a buffer of vertices of the given vertex type.

pub fn add_instance_buffer<I>(self) -> Self where
    I: VertexDescriptor, 

Short-hand for adding a descriptor to the render pipeline describing a buffer of instances of the given vertex type.

pub fn sample_count(self, sample_count: u32) -> Self

The sample count of the output attachment.

pub fn build(self, device: &Device) -> RenderPipeline

Build the render pipeline layout, its descriptor and ultimately the pipeline itself with the specified parameters.

**Panic!**s in the following occur:

• A rasterization state field was specified but no fragment shader was given.
• A color state field was specified but no fragment shader was given.

Trait Implementations

impl<'a> Debug for RenderPipelineBuilder<'a>

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

Formats the value using the given formatter.