RaiSim

Appearance

Get started

raisin::EnvironmentSidecarSettings ​

struct · #include <rayrai/ReflectionProbe.hpp>

Optional environment/lighting overrides from a scene's environment sidecar JSON (<scene>.rayrai_environment.json, see RayraiWindow::loadEnvironmentSidecar()).

Each value is applied only when its matching has* flag is true. Most values map onto the RenderQualitySettings field with the corresponding name (environmentIntensity -> pbrEnvironmentIntensity, skyTint -> pbrEnvironmentSkyTint, sunDirection -> mainLightDirection, exposure -> pbrExposure, bloom*, fogDensity, heightFog*, ...). sunColor*sunIntensity becomes mainLightDiffuse, and backgroundMapPath loads an HDR equirectangular image as the visible background cubemap.

Public attributes ​

hasEnvironmentIntensity ​

cpp
bool hasEnvironmentIntensity

True when the sidecar sets environmentIntensity.

environmentIntensity ​

cpp
float environmentIntensity

Applied to RenderQualitySettings::pbrEnvironmentIntensity.

hasEnvironmentRotation ​

cpp
bool hasEnvironmentRotation

True when the sidecar sets environmentRotation.

environmentRotation ​

cpp
float environmentRotation

Radians about world +Z (the JSON may give "rotation_degrees").

hasSkyTint ​

cpp
bool hasSkyTint

True when the sidecar sets skyTint.

skyTint ​

cpp
glm::vec3 skyTint

Applied to RenderQualitySettings::pbrEnvironmentSkyTint.

hasHorizonTint ​

cpp
bool hasHorizonTint

True when the sidecar sets horizonTint.

horizonTint ​

cpp
glm::vec3 horizonTint

Applied to RenderQualitySettings::pbrEnvironmentHorizonTint.

hasGroundTint ​

cpp
bool hasGroundTint

True when the sidecar sets groundTint.

groundTint ​

cpp
glm::vec3 groundTint

Applied to RenderQualitySettings::pbrEnvironmentGroundTint.

hasHorizonStrength ​

cpp
bool hasHorizonStrength

True when the sidecar sets horizonStrength.

horizonStrength ​

cpp
float horizonStrength

Applied to RenderQualitySettings::pbrEnvironmentHorizonStrength.

hasBackgroundTint ​

cpp
bool hasBackgroundTint

True when the sidecar sets backgroundTint.

backgroundTint ​

cpp
glm::vec3 backgroundTint

Applied to RenderQualitySettings::environmentBackgroundTint.

hasBackgroundExposureScale ​

cpp
bool hasBackgroundExposureScale

True when the sidecar sets backgroundExposureScale.

backgroundExposureScale ​

cpp
float backgroundExposureScale

Applied to RenderQualitySettings::environmentBackgroundExposureScale.

hasBackgroundMapPath ​

cpp
bool hasBackgroundMapPath

True when the sidecar sets backgroundMapPath.

backgroundMapPath ​

cpp
std::string backgroundMapPath

HDR equirectangular image loaded as the visible background.

hasBackgroundMapExposure ​

cpp
bool hasBackgroundMapExposure

True when the sidecar sets backgroundMapExposure.

backgroundMapExposure ​

cpp
float backgroundMapExposure

Exposure for the visible background map.

hasProceduralSkyEnabled ​

cpp
bool hasProceduralSkyEnabled

True when the sidecar sets proceduralSkyEnabled.

proceduralSkyEnabled ​

cpp
bool proceduralSkyEnabled

Applied to RenderQualitySettings::proceduralSkyBackgroundEnabled.

hasProceduralSkySunStrength ​

cpp
bool hasProceduralSkySunStrength

True when the sidecar sets proceduralSkySunStrength.

proceduralSkySunStrength ​

cpp
float proceduralSkySunStrength

Applied to RenderQualitySettings::proceduralSkySunStrength.

hasProceduralSkySunSize ​

cpp
bool hasProceduralSkySunSize

True when the sidecar sets proceduralSkySunSize.

proceduralSkySunSize ​

cpp
float proceduralSkySunSize

Applied to RenderQualitySettings::proceduralSkySunSize (radians).

hasSunDirection ​

cpp
bool hasSunDirection

True when the sidecar sets sunDirection.

sunDirection ​

cpp
glm::vec3 sunDirection

Direction the sunlight travels (toward the ground).

hasSunColor ​

cpp
bool hasSunColor

True when the sidecar sets sunColor.

sunColor ​

cpp
glm::vec3 sunColor

Sun color; mainLightDiffuse = sunColor * sunIntensity.

hasSunIntensity ​

cpp
bool hasSunIntensity

True when the sidecar sets sunIntensity.

sunIntensity ​

cpp
float sunIntensity

Sun intensity; mainLightDiffuse = sunColor * sunIntensity.

hasExposure ​

cpp
bool hasExposure

True when the sidecar sets exposure.

exposure ​

cpp
float exposure

Applied to RenderQualitySettings::pbrExposure.

hasBloomEnabled ​

cpp
bool hasBloomEnabled

True when the sidecar sets bloomEnabled.

bloomEnabled ​

cpp
bool bloomEnabled

Applied to RenderQualitySettings::bloomEnabled.

hasBloomThreshold ​

cpp
bool hasBloomThreshold

True when the sidecar sets bloomThreshold.

bloomThreshold ​

cpp
float bloomThreshold

Applied to RenderQualitySettings::bloomThreshold.

hasBloomStrength ​

cpp
bool hasBloomStrength

True when the sidecar sets bloomStrength.

bloomStrength ​

cpp
float bloomStrength

Applied to RenderQualitySettings::bloomStrength.

hasBloomRadius ​

cpp
bool hasBloomRadius

True when the sidecar sets bloomRadius.

bloomRadius ​

cpp
float bloomRadius

Applied to RenderQualitySettings::bloomRadius.

hasBloomKnee ​

cpp
bool hasBloomKnee

True when the sidecar sets bloomKnee.

bloomKnee ​

cpp
float bloomKnee

Applied to RenderQualitySettings::bloomKnee.

hasBloomQuality ​

cpp
bool hasBloomQuality

True when the sidecar sets bloomQuality.

bloomQuality ​

cpp
int bloomQuality

Applied to RenderQualitySettings::bloomQuality.

hasBloomSourceClamp ​

cpp
bool hasBloomSourceClamp

True when the sidecar sets bloomSourceClamp.

bloomSourceClamp ​

cpp
float bloomSourceClamp

Applied to RenderQualitySettings::bloomSourceClamp.

hasBloomAnamorphic ​

cpp
bool hasBloomAnamorphic

True when the sidecar sets bloomAnamorphic.

bloomAnamorphic ​

cpp
float bloomAnamorphic

Applied to RenderQualitySettings::bloomAnamorphic.

hasBloomDirtStrength ​

cpp
bool hasBloomDirtStrength

True when the sidecar sets bloomDirtStrength.

bloomDirtStrength ​

cpp
float bloomDirtStrength

Applied to RenderQualitySettings::bloomDirtStrength.

hasBloomDirtScale ​

cpp
bool hasBloomDirtScale

True when the sidecar sets bloomDirtScale.

bloomDirtScale ​

cpp
float bloomDirtScale

Applied to RenderQualitySettings::bloomDirtScale.

hasBloomBlendMode ​

cpp
bool hasBloomBlendMode

True when the sidecar sets bloomBlendMode.

bloomBlendMode ​

cpp
GlowBlendMode bloomBlendMode

Applied to RenderQualitySettings::bloomBlendMode.

hasBloomMix ​

cpp
bool hasBloomMix

True when the sidecar sets bloomMix.

bloomMix ​

cpp
float bloomMix

Applied to RenderQualitySettings::bloomMix.

hasFogDensity ​

cpp
bool hasFogDensity

True when the sidecar sets fogDensity.

fogDensity ​

cpp
float fogDensity

Applied to RenderQualitySettings::fogDensity.

hasHeightFogEnabled ​

cpp
bool hasHeightFogEnabled

True when the sidecar sets heightFogEnabled.

heightFogEnabled ​

cpp
bool heightFogEnabled

Applied to RenderQualitySettings::heightFogEnabled.

hasHeightFogDensity ​

cpp
bool hasHeightFogDensity

True when the sidecar sets heightFogDensity.

heightFogDensity ​

cpp
float heightFogDensity

Applied to RenderQualitySettings::heightFogDensity.

hasHeightFogBaseHeight ​

cpp
bool hasHeightFogBaseHeight

True when the sidecar sets heightFogBaseHeight.

heightFogBaseHeight ​

cpp
float heightFogBaseHeight

Applied to RenderQualitySettings::heightFogBaseHeight.

hasHeightFogFalloff ​

cpp
bool hasHeightFogFalloff

True when the sidecar sets heightFogFalloff.

heightFogFalloff ​

cpp
float heightFogFalloff

Applied to RenderQualitySettings::heightFogFalloff.

RaiSim — physics for robotics and AI.

© 2026 RaiSim Tech Inc.