Struct web_glitz::render_pass::DefaultStencilBuffer

pub struct DefaultStencilBuffer { /* fields omitted */ }

Represents the depth-stencil buffer for a [DefaultRenderTarget] with only a stencil channel and no depth channel.

Methods

impl DefaultStencilBuffer

pub fn clear_command(
    &self,
    stencil: i32,
    region: Region2D
) -> ClearStencilCommand

Returns a command that clears all stencil values in the region to stencil.

Values outside the region are unaffected.

Examples

The following command will clear the entire depth-stencil buffer to a stencil value of 0:

let command = buffer.clear_command(0, Region2D::Fill);

It's also possible to only clear a specific rectangular area of the buffer:

let command = buffer.clear_command(0, Region2D::Area((0, 0), 100, 100));

See also Region2D.