Kanzi 4.1.0
kanzi::DebugVisualization::ScopedVisiblePass Class Reference

RAII helper class for rendering visible parts of debug objects. More...

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

Public Member Functions

ScopedVisiblePassoperator= (const ScopedVisiblePass &)=delete
 
 ScopedVisiblePass (const ScopedVisiblePass &)=delete
 Non-copyable.
 
 ScopedVisiblePass (Renderer &renderer)
 Constructor - pushes visible pass rendering settings.
 
 ~ScopedVisiblePass ()
 Destructor - pops rendering settings.
 

Detailed Description

RAII helper class for rendering visible parts of debug objects.

Use this when rendering multiple parts that should depth-test against each other. All parts rendered within this scope will be fully opaque and write to depth buffer. After this scope, use ScopedOccludedPass to render the same parts with transparency.

When used within a ScopedDebugRenderSession, visible parts are marked in the stencil buffer so that the occluded pass (in the next phase) will skip those pixels across all debug objects.

Constructor & Destructor Documentation

◆ ScopedVisiblePass() [1/2]

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

Constructor - pushes visible pass rendering settings.

Parameters
rendererRenderer to use.

◆ ~ScopedVisiblePass()

kanzi::DebugVisualization::ScopedVisiblePass::~ScopedVisiblePass ( )

Destructor - pops rendering settings.

◆ ScopedVisiblePass() [2/2]

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

Non-copyable.

Member Function Documentation

◆ operator=()

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

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