Struct DebugVis 

#[non_exhaustive]
pub struct DebugVis {
    pub active: bool,
    pub mode: DebugOutputMode,
    pub channel_r: DebugQuantity,
    pub channel_g: DebugQuantity,
    pub channel_b: DebugQuantity,
    pub scale: f32,
    pub split_x: f32,
}

Debug visualization configuration for the shadow and lighting pipeline.

Attach to [LightingSettings::debug_vis] to activate per-fragment channel output. When active is false all overhead is zero: debug_vis_mode is written as 0 and the shader exits the debug path immediately.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

active: bool

Whether debug visualization is active.

mode: DebugOutputMode

How the debug value is composited over the normal render.

channel_r: DebugQuantity

Quantity shown in the red channel.

channel_g: DebugQuantity

Quantity shown in the green channel.

channel_b: DebugQuantity

Quantity shown in the blue channel.

scale: f32

Multiplier applied to the raw quantity value before display. Use values > 1.0 to bring small quantities (e.g. bias in world units) into visible range.

split_x: f32

Split position for SplitScreen mode, in normalized viewport coordinates (0..1). 0.5 = center. Ignored unless mode is SplitScreen.

Implementations

impl DebugVis

pub fn new( mode: DebugOutputMode, channel_r: DebugQuantity, channel_g: DebugQuantity, channel_b: DebugQuantity, scale: f32, ) -> Self

Create a new active debug visualization configuration.

pub fn pack_mode(&self) -> u32

Pack the channel selectors, output mode, and active flag into a single u32.

Bit layout: bits 0..5 : channel R quantity index (5 bits, up to 32 quantities) bits 5..10 : channel G quantity index bits 10..15 : channel B quantity index bits 15..17 : output mode (0=Replace, 1=TintOverlay) bit 31 : active flag (0=off, non-zero=on)

Returns 0 when not active, so the shader exits immediately.

Trait Implementations

impl Clone for DebugVis

fn clone(&self) -> DebugVis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebugVis

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

Formats the value using the given formatter.

impl Default for DebugVis

fn default() -> DebugVis

Returns the “default value” for a type.