Kanzi 4.1.0
kanzi::DebugVisualization::ScopedDebugRenderSession Class Reference

RAII helper class for coordinating two-phase debug rendering across multiple objects. More...

#include <kanzi/core.ui/node/debug_visualization.hpp>

Public Member Functions

ScopedDebugRenderSessionoperator= (const ScopedDebugRenderSession &)=delete
 
 ScopedDebugRenderSession (const ScopedDebugRenderSession &)=delete
 Non-copyable.
 
 ScopedDebugRenderSession (Renderer &renderer)
 Constructor - clears stencil buffer and sets up session state.
 
 ~ScopedDebugRenderSession ()
 Destructor - ends session and resets phase to None.
 

Static Public Member Functions

static DebugRenderPhase getCurrentPhase ()
 Gets the current render phase.
 

Friends

class DebugVisualization
 

Detailed Description

RAII helper class for coordinating two-phase debug rendering across multiple objects.

When rendering multiple debug objects (cameras, lights, etc.), use this class to ensure that ALL visible parts are rendered before ANY occluded parts. This prevents the occluded (transparent) pass of one debug object from drawing on top of the visible pass of another.

Constructor & Destructor Documentation

◆ ScopedDebugRenderSession() [1/2]

kanzi::DebugVisualization::ScopedDebugRenderSession::ScopedDebugRenderSession ( Renderer & renderer)
explicit

Constructor - clears stencil buffer and sets up session state.

Parameters
rendererRenderer to use.

◆ ~ScopedDebugRenderSession()

kanzi::DebugVisualization::ScopedDebugRenderSession::~ScopedDebugRenderSession ( )

Destructor - ends session and resets phase to None.

◆ ScopedDebugRenderSession() [2/2]

kanzi::DebugVisualization::ScopedDebugRenderSession::ScopedDebugRenderSession ( const ScopedDebugRenderSession & )
delete

Non-copyable.

Member Function Documentation

◆ getCurrentPhase()

static DebugRenderPhase kanzi::DebugVisualization::ScopedDebugRenderSession::getCurrentPhase ( )
static

Gets the current render phase.

Returns
Current debug render phase.

◆ operator=()

ScopedDebugRenderSession & kanzi::DebugVisualization::ScopedDebugRenderSession::operator= ( const ScopedDebugRenderSession & )
delete

Friends And Related Symbol Documentation

◆ DebugVisualization


The documentation for this class was generated from the following file: