Struct web_glitz::render_pass::DepthStencilBuffer

pub struct DepthStencilBuffer<F> where
    F: DepthStencilRenderable,  { /* fields omitted */ }

Represents a depth-stencil buffer that stores both depth and stencil values in a framebuffer for a custom render target.

Methods

impl<F> DepthStencilBuffer<F> where
    F: DepthStencilRenderable, 

pub fn clear_command(
    &self,
    depth: f32,
    stencil: i32,
    region: Region2D
) -> ClearDepthStencilCommand

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

Values outside the region are unaffected. See also [clear_depth_command] for a command that clears only depth values, and [clear_stencil_command] for a command that clears only stencil values.

Examples

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

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

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

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

See also Region2D.

pub fn clear_depth_command(
    &self,
    depth: f32,
    region: Region2D
) -> ClearDepthCommand

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

Stencil values and depth values outside the region are unaffected. See also [clear_stencil_command] for a command that clears stencil values, and [clear_command] for a command that clears both depth and stencil values.

Examples

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

let command = buffer.clear_depth_command(1.0, Region2D::Fill);

The stencil values in the depth-stencil buffer will not change.

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

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

See also Region2D.

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

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

Depth values and stencil values outside the region are unaffected. See also [clear_depth_command] for a command that clears depth values, and [clear_command] for a command that clears both depth and stencil values.

Examples

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

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

The depth values in the depth-stencil buffer will not change.

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

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

See also Region2D.

Trait Implementations

impl<F> RenderingOutputBuffer for DepthStencilBuffer<F> where
    F: DepthStencilRenderable, 

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).