Skip to content

raisin::ShadowDebugOverlaySummary ​

struct · #include <rayrai/RenderDiagnostics.hpp>

CPU summary shown by the optional shadow debug overlay (RayraiWindow::shadowDebugOverlaySummary()).

Settings fields echo RenderQualitySettings; cascade and atlas fields come from DirectionalShadowCascadePlan and ShadowAtlasPlan for the viewer camera.

Public attributes ​

available ​

cpp
bool available

Summary was produced.

overlayEnabled ​

cpp
bool overlayEnabled

RenderQualitySettings::shadowDebugOverlayEnabled.

shadowsEnabled ​

cpp
bool shadowsEnabled

Shadows enabled in the settings and on the main light.

updateEveryFrame ​

cpp
bool updateEveryFrame

RenderQualitySettings::updateShadowsEveryFrame.

contactHardening ​

cpp
bool contactHardening

RenderQualitySettings::shadowContactHardening.

cascadeRendered ​

cpp
bool cascadeRendered

Cascaded directional shadow maps were rendered.

atlasRendered ​

cpp
bool atlasRendered

The additional-light shadow atlas was rendered.

atlasOverflow ​

cpp
bool atlasOverflow

ShadowAtlasPlan::overflow.

splitOverridesEnabled ​

cpp
bool splitOverridesEnabled

DirectionalShadowCascadePlan::splitOverridesEnabled.

cascadeCount ​

cpp
int cascadeCount

Planned cascade count.

atlasTileCount ​

cpp
int atlasTileCount

ShadowAtlasPlan::tileCount.

atlasNonPointTileCount ​

cpp
int atlasNonPointTileCount

ShadowAtlasPlan::nonPointTileCount.

pointShadowFaceTileCount ​

cpp
int pointShadowFaceTileCount

ShadowAtlasPlan::pointShadowFaceTileCount.

selectedAdditionalShadowLights ​

cpp
int selectedAdditionalShadowLights

Additional lights given shadow maps.

droppedShadowCandidates ​

cpp
int droppedShadowCandidates

Shadow-casting candidates not selected (budget, policy, zero influence).

shadowBias ​

cpp
float shadowBias

RenderQualitySettings::shadowBias.

shadowNormalOffset ​

cpp
float shadowNormalOffset

RenderQualitySettings::shadowNormalOffset.

shadowPcfRadius ​

cpp
float shadowPcfRadius

RenderQualitySettings::shadowPcfRadius.

shadowStrength ​

cpp
float shadowStrength

RenderQualitySettings::shadowStrength.

cascadeLambda ​

cpp
float cascadeLambda

DirectionalShadowCascadePlan::lambda.

cascadeMaxDistance ​

cpp
float cascadeMaxDistance

DirectionalShadowCascadePlan::maxDistance, metres.

atlasOccupancy ​

cpp
float atlasOccupancy

ShadowAtlasPlan::occupancy.

cascadeSplits ​

cpp
std::array<float, 4> cascadeSplits

Far split distance of each cascade, metres.

cascadeSplitOverrides ​

cpp
std::array<float, 4> cascadeSplitOverrides

DirectionalShadowCascadePlan::splitOverrides.

cascadeMode ​

cpp
std::string cascadeMode

"rendered_stable_cascades", "planned_stable_cascades" or "single_shadow_map".

atlasMode ​

cpp
std::string atlasMode

"rendered_2d_atlas_point_standalone", "planned_atlas_standalone_textures" or "standalone_textures".

RaiSim — physics for robotics and AI.