Struct web_glitz::render_pass::StencilBuffer

pub struct StencilBuffer<F> where
    F: StencilRenderable,  { /* fields omitted */ }

Methods

impl<F> StencilBuffer<F> where
    F: StencilRenderable, 

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.

Trait Implementations

impl<F> RenderingOutputBuffer for StencilBuffer<F> where
    F: StencilRenderable, 

type Format = F

The type image storage format used by the buffer.

fn width(&self) -> u32

The width of the buffer (in pixels).

fn height(&self) -> u32

The height of the buffer (in pixels).