Struct StencilFrameState

pub struct StencilFrameState {
    pub cleared: bool,
    pub next_ref: u32,
}

Per-frame stencil state (global clear + reference value per layer).

Examples

use ailloli_ui_render_wgpu::stencil::StencilFrameState;
let state = StencilFrameState::default();
assert_eq!((state.cleared, state.next_ref), (false, 0));

Fields

cleared: bool

Whether the attachment has been cleared during this reference cycle.

next_ref: u32

Last stencil reference allocated, in the range 0..=255.

Implementations

impl StencilFrameState

pub fn begin_layer(&mut self) -> (LoadOp<u32>, u32)

Allocates the next nonzero eight-bit reference and required load op.

The first layer clears to zero and returns reference 1. Subsequent layers load and increment through 255. The next request clears again and wraps to reference 1.

Examples

use ailloli_ui_render_wgpu::stencil::StencilFrameState;
let mut state = StencilFrameState::default();
let (load, reference) = state.begin_layer();
assert!(matches!(load, wgpu::LoadOp::Clear(0)));
assert_eq!(reference, 1);

Trait Implementations

impl Debug for StencilFrameState

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

Formats the value using the given formatter.

impl Default for StencilFrameState

fn default() -> StencilFrameState

Returns the “default value” for a type.