Struct StencilClipState 

pub struct StencilClipState { /* private fields */ }

Tracks the current stencil clip depth.

Each push_stencil_clip increments the reference value (max 254); each pop_stencil_clip decrements it.

Implementations

impl StencilClipState

pub fn reference(&self) -> u32

Current stencil reference value. Draw passes should use this as the stencil compare reference.

pub fn push(&mut self) -> Option<u32>

Increment the clip depth (called when pushing a non-rectangular clip). Returns the new reference value, or None if the depth is already at the maximum (254).

pub fn pop(&mut self)

Decrement the clip depth (called when popping a non-rectangular clip).

pub fn reset(&mut self)

Reset the clip depth to zero.

Trait Implementations

impl Clone for StencilClipState

fn clone(&self) -> StencilClipState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StencilClipState

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

Formats the value using the given formatter.

impl Default for StencilClipState

fn default() -> StencilClipState

Returns the “default value” for a type.