RaiSim

Appearance

Get started

raisin::RayraiWindow::EnvironmentSidecarSettings ​

struct · #include <rayrai/RayraiWindow.hpp>

Contents of a .rayrai_environment.json sidecar (see loadEnvironmentSidecar()).

Each value has a hasX flag that is true only when the sidecar provided it; applyEnvironmentSidecarSettings() copies only flagged values. Plain keys are read from the environment object when it exists, otherwise from the top level; the procedural_sky, sun, bloom/glow and height_fog groups may sit at either level. Values are clamped to the ranges noted below.

Public attributes ​

hasEnvironmentIntensity ​

cpp
bool hasEnvironmentIntensity

Set when environment.intensity was present.

environmentIntensity ​

cpp
float environmentIntensity

RenderQualitySettings::pbrEnvironmentIntensity (>= 0).

hasEnvironmentRotation ​

cpp
bool hasEnvironmentRotation

Set when environment.rotation (radians) or rotation_degrees was present.

environmentRotation ​

cpp
float environmentRotation

RenderQualitySettings::pbrEnvironmentRotation, in radians.

hasSkyTint ​

cpp
bool hasSkyTint

Set when environment.sky_tint was present.

skyTint ​

cpp
glm::vec3 skyTint

RenderQualitySettings::pbrEnvironmentSkyTint (>= 0).

hasHorizonTint ​

cpp
bool hasHorizonTint

Set when environment.horizon_tint was present.

horizonTint ​

cpp
glm::vec3 horizonTint

RenderQualitySettings::pbrEnvironmentHorizonTint (>= 0).

hasGroundTint ​

cpp
bool hasGroundTint

Set when environment.ground_tint was present.

groundTint ​

cpp
glm::vec3 groundTint

RenderQualitySettings::pbrEnvironmentGroundTint (>= 0).

hasHorizonStrength ​

cpp
bool hasHorizonStrength

Set when environment.horizon_strength was present.

horizonStrength ​

cpp
float horizonStrength

RenderQualitySettings::pbrEnvironmentHorizonStrength, in [0, 1].

hasBackgroundTint ​

cpp
bool hasBackgroundTint

Set when environment.background_tint was present.

backgroundTint ​

cpp
glm::vec3 backgroundTint

RenderQualitySettings::environmentBackgroundTint (>= 0).

hasBackgroundExposureScale ​

cpp
bool hasBackgroundExposureScale

Set when environment.background_exposure_scale was present.

backgroundExposureScale ​

cpp
float backgroundExposureScale

RenderQualitySettings::environmentBackgroundExposureScale (>= 0).

hasBackgroundMapPath ​

cpp
bool hasBackgroundMapPath

Set when environment.background_map or visible_background_map was present.

backgroundMapPath ​

cpp
std::string backgroundMapPath

Equirectangular .hdr shown as the visible background; relative paths resolve against the sidecar.

hasBackgroundMapExposure ​

cpp
bool hasBackgroundMapExposure

Set when environment.background_map_exposure was present.

backgroundMapExposure ​

cpp
float backgroundMapExposure

Exposure of the visible background map (>= 0).

hasProceduralSkyEnabled ​

cpp
bool hasProceduralSkyEnabled

Set when procedural_sky.enabled was present.

proceduralSkyEnabled ​

cpp
bool proceduralSkyEnabled

RenderQualitySettings::proceduralSkyBackgroundEnabled.

hasProceduralSkySunStrength ​

cpp
bool hasProceduralSkySunStrength

Set when procedural_sky.sun_strength was present.

proceduralSkySunStrength ​

cpp
float proceduralSkySunStrength

RenderQualitySettings::proceduralSkySunStrength (>= 0).

hasProceduralSkySunSize ​

cpp
bool hasProceduralSkySunSize

Set when procedural_sky.sun_size was present.

proceduralSkySunSize ​

cpp
float proceduralSkySunSize

RenderQualitySettings::proceduralSkySunSize (>= 0.0001).

hasSunDirection ​

cpp
bool hasSunDirection

Set when sun.direction or sun.azimuth_degrees + sun.elevation_degrees was present.

sunDirection ​

cpp
glm::vec3 sunDirection

Normalized RenderQualitySettings::mainLightDirection (direction the light travels, world frame).

hasSunColor ​

cpp
bool hasSunColor

Set when sun.color was present.

sunColor ​

cpp
glm::vec3 sunColor

Sun color; mainLightDiffuse becomes sunColor * sunIntensity.

hasSunIntensity ​

cpp
bool hasSunIntensity

Set when sun.intensity was present.

sunIntensity ​

cpp
float sunIntensity

Sun intensity multiplier (>= 0).

hasExposure ​

cpp
bool hasExposure

Set when environment.exposure was present.

exposure ​

cpp
float exposure

RenderQualitySettings::pbrExposure (>= 0).

hasBloomEnabled ​

cpp
bool hasBloomEnabled

Set when bloom.enabled (or glow.enabled) was present.

bloomEnabled ​

cpp
bool bloomEnabled

RenderQualitySettings::bloomEnabled.

hasBloomThreshold ​

cpp
bool hasBloomThreshold

Set when bloom.threshold was present.

bloomThreshold ​

cpp
float bloomThreshold

RenderQualitySettings::bloomThreshold (>= 0).

hasBloomStrength ​

cpp
bool hasBloomStrength

Set when bloom.strength was present.

bloomStrength ​

cpp
float bloomStrength

RenderQualitySettings::bloomStrength (>= 0).

hasBloomRadius ​

cpp
bool hasBloomRadius

Set when bloom.radius was present.

bloomRadius ​

cpp
float bloomRadius

RenderQualitySettings::bloomRadius (>= 0).

hasBloomKnee ​

cpp
bool hasBloomKnee

Set when bloom.knee was present.

bloomKnee ​

cpp
float bloomKnee

RenderQualitySettings::bloomKnee (>= 0.001).

hasBloomQuality ​

cpp
bool hasBloomQuality

Set when bloom.quality was present.

bloomQuality ​

cpp
int bloomQuality

RenderQualitySettings::bloomQuality, in [1, 3].

hasBloomSourceClamp ​

cpp
bool hasBloomSourceClamp

Set when bloom.source_clamp was present.

bloomSourceClamp ​

cpp
float bloomSourceClamp

RenderQualitySettings::bloomSourceClamp (>= 0).

hasBloomAnamorphic ​

cpp
bool hasBloomAnamorphic

Set when bloom.anamorphic was present.

bloomAnamorphic ​

cpp
float bloomAnamorphic

RenderQualitySettings::bloomAnamorphic, in [0, 1].

hasBloomDirtStrength ​

cpp
bool hasBloomDirtStrength

Set when bloom.dirt_strength was present.

bloomDirtStrength ​

cpp
float bloomDirtStrength

RenderQualitySettings::bloomDirtStrength, in [0, 1].

hasBloomDirtScale ​

cpp
bool hasBloomDirtScale

Set when bloom.dirt_scale was present.

bloomDirtScale ​

cpp
float bloomDirtScale

RenderQualitySettings::bloomDirtScale, in [0.05, 32].

hasBloomBlendMode ​

cpp
bool hasBloomBlendMode

Set when bloom.blend_mode (or glow_blend_mode, mode) was present.

bloomBlendMode ​

cpp
GlowBlendMode bloomBlendMode

RenderQualitySettings::bloomBlendMode.

hasBloomMix ​

cpp
bool hasBloomMix

Set when bloom.mix (or glow_mix) was present.

bloomMix ​

cpp
float bloomMix

RenderQualitySettings::bloomMix, in [0, 1].

hasFogDensity ​

cpp
bool hasFogDensity

Set when environment.fog_density was present.

fogDensity ​

cpp
float fogDensity

RenderQualitySettings::fogDensity (>= 0).

hasHeightFogEnabled ​

cpp
bool hasHeightFogEnabled

Set when height_fog.enabled was present.

heightFogEnabled ​

cpp
bool heightFogEnabled

RenderQualitySettings::heightFogEnabled.

hasHeightFogDensity ​

cpp
bool hasHeightFogDensity

Set when height_fog.density was present.

heightFogDensity ​

cpp
float heightFogDensity

RenderQualitySettings::heightFogDensity (>= 0).

hasHeightFogBaseHeight ​

cpp
bool hasHeightFogBaseHeight

Set when height_fog.base_height was present.

heightFogBaseHeight ​

cpp
float heightFogBaseHeight

RenderQualitySettings::heightFogBaseHeight (world Z, metres).

hasHeightFogFalloff ​

cpp
bool hasHeightFogFalloff

Set when height_fog.falloff was present.

heightFogFalloff ​

cpp
float heightFogFalloff

RenderQualitySettings::heightFogFalloff (>= 0).

RaiSim — physics for robotics and AI.

© 2026 RaiSim Tech Inc.