Struct wgpu::RenderPass

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

An in-progress recording of a render pass.

Methods

impl<'a> RenderPass<'a>

pub fn set_bind_group(
    &mut self,
    index: u32,
    bind_group: &BindGroup,
    offsets: &[BufferAddress]
)

Sets the active bind group for a given bind group index.

pub fn set_pipeline(&mut self, pipeline: &RenderPipeline)

Sets the active render pipeline.

Subsequent draw calls will exhibit the behavior defined by pipeline.

pub fn set_blend_color(&mut self, color: Color)

pub fn set_index_buffer(&mut self, buffer: &Buffer, offset: BufferAddress)

Sets the active index buffer.

Subsequent calls to draw_indexed on this RenderPass will use buffer as the source index buffer.

pub fn set_vertex_buffers(
    &mut self,
    start_slot: u32,
    buffer_pairs: &[(&Buffer, BufferAddress)]
)

Sets the active vertex buffers, starting from start_slot.

Each element of buffer_pairs describes a vertex buffer and an offset in bytes into that buffer. The offset must be aligned to a multiple of 4 bytes.

pub fn set_scissor_rect(&mut self, x: u32, y: u32, w: u32, h: u32)

Sets the scissor region.

Subsequent draw calls will discard any fragments that fall outside this region.

pub fn set_viewport(
    &mut self,
    x: f32,
    y: f32,
    w: f32,
    h: f32,
    min_depth: f32,
    max_depth: f32
)

Sets the viewport region.

Subsequent draw calls will draw any fragments in this region.

pub fn set_stencil_reference(&mut self, reference: u32)

Sets the stencil reference.

Subsequent stencil tests will test against this value.

pub fn draw(&mut self, vertices: Range<u32>, instances: Range<u32>)

Draws primitives from the active vertex buffer(s).

The active vertex buffers can be set with RenderPass::set_vertex_buffers.

pub fn draw_indexed(
    &mut self,
    indices: Range<u32>,
    base_vertex: i32,
    instances: Range<u32>
)

Draws indexed primitives using the active index buffer and the active vertex buffers.

The active index buffer can be set with RenderPass::set_index_buffer, while the active vertex buffers can be set with RenderPass::set_vertex_buffers.

Trait Implementations

impl<'a> Drop for RenderPass<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Debug for RenderPass<'a>

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

Formats the value using the given formatter.