Skip to content

raisin::WeatherDiagnostics ​

struct · #include <rayrai/Weather.hpp>

Resolved weather state for the current frame (RayraiWindow::weatherDiagnostics()).

Echoes the WeatherSettings inputs and reports the values the renderer derives from them. Strengths are normalized [0, 1] unless noted.

Public attributes ​

enabled ​

cpp
bool enabled

WeatherSettings::enabled.

viewerEffectsActive ​

cpp
bool viewerEffectsActive

Weather effects are drawn in the viewer (same as enabled).

affectsSensors ​

cpp
bool affectsSensors

WeatherSettings::affectSensors.

preset ​

cpp
WeatherPreset preset

WeatherSettings::preset.

quality ​

cpp
WeatherQuality quality

WeatherSettings::quality.

seed ​

cpp
uint32_t seed

WeatherSettings::seed.

timeOfDayHours ​

cpp
float timeOfDayHours

WeatherSettings::timeOfDayHours.

latitude ​

cpp
float latitude

WeatherSettings::latitude, degrees.

longitude ​

cpp
float longitude

WeatherSettings::longitude, degrees.

automaticUtcOffset ​

cpp
bool automaticUtcOffset

WeatherSettings::automaticUtcOffset.

utcOffsetHours ​

cpp
float utcOffsetHours

WeatherSettings::utcOffsetHours.

resolvedUtcOffsetHours ​

cpp
float resolvedUtcOffsetHours

Offset actually used: longitude / 15 when automatic.

year ​

cpp
int year

WeatherSettings::year.

month ​

cpp
int month

WeatherSettings::month.

day ​

cpp
int day

WeatherSettings::day.

solarAzimuthDegrees ​

cpp
float solarAzimuthDegrees

Resolved solar azimuth, degrees.

solarElevationDegrees ​

cpp
float solarElevationDegrees

Resolved solar elevation, degrees.

sunDirection ​

cpp
glm::vec3 sunDirection

Direction sunlight travels (toward the ground).

sunColor ​

cpp
glm::vec3 sunColor

Sun color after turbidity and cloud cover.

sunIntensity ​

cpp
float sunIntensity

Direct sun strength after daylight, clouds and precipitation (0 when disabled).

moonLightActive ​

cpp
bool moonLightActive

Night: the moon drives the main light.

moonDirection ​

cpp
glm::vec3 moonDirection

Direction moonlight travels.

moonIntensity ​

cpp
float moonIntensity

Moonlight strength.

skyExposure ​

cpp
float skyExposure

Sky brightness factor used for ambient, environment and exposure, [0.04, 1.35].

cloudCoverage ​

cpp
float cloudCoverage

WeatherSettings::cloudCoverage.

cloudDensity ​

cpp
float cloudDensity

WeatherSettings::cloudDensity.

cloudLayerActive ​

cpp
bool cloudLayerActive

Cloud layer drawn (coverage and density > 0.015, quality above Low).

cloudShadowActive ​

cpp
bool cloudShadowActive

Cloud shadows projected (High/Ultra with a non-zero strength).

cloudAltitudeMeters ​

cpp
float cloudAltitudeMeters

WeatherSettings::cloudAltitudeMeters.

cloudThicknessMeters ​

cpp
float cloudThicknessMeters

WeatherSettings::cloudThicknessMeters.

cloudShadowStrength ​

cpp
float cloudShadowStrength

Effective cloud-shadow strength (scaled by coverage).

cloudScale ​

cpp
float cloudScale

WeatherSettings::cloudScale.

cloudOffset ​

cpp
glm::vec2 cloudOffset

Current cloud drift offset.

fogDensity ​

cpp
float fogDensity

WeatherSettings::fogDensity.

visibilityMeters ​

cpp
float visibilityMeters

WeatherSettings::visibilityMeters.

heightFogActive ​

cpp
bool heightFogActive

Weather height fog is on (fog density > 0.001 or visibility < 5 km).

volumetricFogActive ​

cpp
bool volumetricFogActive

Weather volumetric fog is on (Ultra quality and enough fog).

heightFogDensity ​

cpp
float heightFogDensity

Effective height-fog density, metres^-1.

heightFogBaseHeight ​

cpp
float heightFogBaseHeight

Height-fog base height, metres.

heightFogFalloff ​

cpp
float heightFogFalloff

Height-fog falloff, 1/metres.

fogColor ​

cpp
glm::vec3 fogColor

WeatherSettings::fogColor.

fogAnisotropy ​

cpp
float fogAnisotropy

WeatherSettings::fogAnisotropy.

visibilityTransmittance100m ​

cpp
float visibilityTransmittance100m

exp(-heightFogDensity * 100 m).

visibilityTransmittance1km ​

cpp
float visibilityTransmittance1km

exp(-heightFogDensity * 1000 m).

localFogVolumeBudget ​

cpp
size_t localFogVolumeBudget

kMaxLocalFogVolumes.

localFogVolumeCount ​

cpp
size_t localFogVolumeCount

Registered local fog volumes.

localFogPositiveDensity ​

cpp
float localFogPositiveDensity

Sum of positive local fog densities.

localFogNegativeDensity ​

cpp
float localFogNegativeDensity

Sum of negative (clearing) local fog densities.

precipitationRate ​

cpp
float precipitationRate

WeatherSettings::precipitationRate.

effectivePrecipitationRate ​

cpp
float effectivePrecipitationRate

precipitationRate * (1 - rainOcclusionStrength).

rainOcclusionStrength ​

cpp
float rainOcclusionStrength

WeatherSettings::rainOcclusionStrength.

wetness ​

cpp
float wetness

Resolved surface wetness after occlusion and snow melt.

wetnessAccumulationActive ​

cpp
bool wetnessAccumulationActive

Wetness accumulates over time.

accumulatedWetness ​

cpp
float accumulatedWetness

Current accumulated wetness (or WeatherSettings::wetness when not accumulating).

wetnessAccumulationRate ​

cpp
float wetnessAccumulationRate

WeatherSettings::wetnessAccumulationRate.

wetnessDryingRate ​

cpp
float wetnessDryingRate

WeatherSettings::wetnessDryingRate.

wetMaterialActive ​

cpp
bool wetMaterialActive

Wet-material shading applied.

wetMaterialStrength ​

cpp
float wetMaterialStrength

Wet-material strength.

puddleStrength ​

cpp
float puddleStrength

Puddle strength (wet strength above 0.42).

rainRippleStrength ​

cpp
float rainRippleStrength

Rain-ripple strength on puddles.

wetAlbedoDarkening ​

cpp
float wetAlbedoDarkening

Albedo darkening applied to wet surfaces.

wetRoughnessScale ​

cpp
float wetRoughnessScale

Roughness multiplier for wet surfaces.

wetSpecularBoost ​

cpp
float wetSpecularBoost

Specular boost for wet surfaces.

snowCoverage ​

cpp
float snowCoverage

WeatherSettings::snowCoverage.

snowMeltActive ​

cpp
bool snowMeltActive

Snow is melting during a transition away from snow.

snowMeltFactor ​

cpp
float snowMeltFactor

Melt progress.

snowMeltWetnessBoost ​

cpp
float snowMeltWetnessBoost

Extra wetness added by melting snow.

snowMaterialActive ​

cpp
bool snowMaterialActive

Snow-material shading applied.

snowMaterialStrength ​

cpp
float snowMaterialStrength

Snow-material strength.

snowAccumulationStrength ​

cpp
float snowAccumulationStrength

Snow accumulation strength.

snowAlbedoBlend ​

cpp
float snowAlbedoBlend

Blend toward snow albedo.

snowRoughness ​

cpp
float snowRoughness

Roughness of snow-covered surfaces.

snowMetallicScale ​

cpp
float snowMetallicScale

Metallic multiplier under snow.

snowNormalSoftening ​

cpp
float snowNormalSoftening

Normal-map softening under snow.

lightningRate ​

cpp
float lightningRate

WeatherSettings::lightningRate, strikes per minute.

lightningActive ​

cpp
bool lightningActive

A strike is currently flashing.

lightningEventIndex ​

cpp
uint32_t lightningEventIndex

Index of the current/most recent strike slot.

lightningEventTimeSeconds ​

cpp
float lightningEventTimeSeconds

Start time of that strike, seconds of the day.

lightningNextEventSeconds ​

cpp
float lightningNextEventSeconds

Seconds until the next strike slot.

lightningEventPhaseSeconds ​

cpp
float lightningEventPhaseSeconds

Seconds since the current strike started.

lightningEventDurationSeconds ​

cpp
float lightningEventDurationSeconds

Flash duration, seconds.

lightningIntensity ​

cpp
float lightningIntensity

Current flash intensity.

lightningExposureBoost ​

cpp
float lightningExposureBoost

Exposure added during the flash.

lightningSkyFlash ​

cpp
float lightningSkyFlash

Sky brightening during the flash.

lightningDirection ​

cpp
glm::vec3 lightningDirection

Direction the flash light travels (used as the main light while active).

lightningColor ​

cpp
glm::vec3 lightningColor

Flash color.

lightningPointLightActive ​

cpp
bool lightningPointLightActive

The local lightning point light is active.

lightningPointLightPosition ​

cpp
glm::vec3 lightningPointLightPosition

Its world position, metres.

lightningPointLightColor ​

cpp
glm::vec3 lightningPointLightColor

Its color.

lightningPointLightRadius ​

cpp
float lightningPointLightRadius

Its radius, metres.

lightningPointLightIntensity ​

cpp
float lightningPointLightIntensity

Its current intensity.

thunderDelaySeconds ​

cpp
float thunderDelaySeconds

Delay from flash to thunder, seconds.

precipitationParticlesActive ​

cpp
bool precipitationParticlesActive

Rain or snow particles are drawn.

snowParticlesActive ​

cpp
bool snowParticlesActive

Snow particles are drawn.

rainParticlesActive ​

cpp
bool rainParticlesActive

Rain particles are drawn.

precipitationParticleBudget ​

cpp
size_t precipitationParticleBudget

Particle budget from rate and quality.

precipitationParticlesRendered ​

cpp
size_t precipitationParticlesRendered

Particles drawn per frame (capped by quality).

precipitationParticleSizePixels ​

cpp
float precipitationParticleSizePixels

Particle size, pixels.

precipitationParticleDepthMeters ​

cpp
float precipitationParticleDepthMeters

Depth of the camera-relative particle volume, metres.

precipitationParticleAlpha ​

cpp
float precipitationParticleAlpha

Particle opacity.

precipitationParticleColor ​

cpp
glm::vec3 precipitationParticleColor

Particle color.

rainSplashParticlesActive ​

cpp
bool rainSplashParticlesActive

Always false: rain splashes are disabled (kept for schema stability).

rainSplashParticlesRendered ​

cpp
size_t rainSplashParticlesRendered

Always 0.

rainSplashParticleSizePixels ​

cpp
float rainSplashParticleSizePixels

Always 0.

rainSplashParticleAlpha ​

cpp
float rainSplashParticleAlpha

Always 0.

rainSplashParticleColor ​

cpp
glm::vec3 rainSplashParticleColor

Unused splash color.

lensDropletsActive ​

cpp
bool lensDropletsActive

Lens droplets are drawn.

lensDropletsRendered ​

cpp
size_t lensDropletsRendered

Droplets drawn.

lensDropletStrength ​

cpp
float lensDropletStrength

WeatherSettings::lensDropletStrength.

lensDropletMaxSizePixels ​

cpp
float lensDropletMaxSizePixels

Largest droplet size, pixels.

lensDropletAlpha ​

cpp
float lensDropletAlpha

Droplet opacity.

weatherTextureBytes ​

cpp
size_t weatherTextureBytes

Currently always 0.

transitionActive ​

cpp
bool transitionActive

A transitionWeather() blend is in progress.

transitionAlpha ​

cpp
float transitionAlpha

Transition progress, [0, 1].

skyEnvironmentValid ​

cpp
bool skyEnvironmentValid

A generated weather sky environment exists (see WeatherSkyEnvironment).

skyEnvironmentMap ​

cpp
unsigned int skyEnvironmentMap

WeatherSkyEnvironment::environmentMap.

skyIrradianceMap ​

cpp
unsigned int skyIrradianceMap

WeatherSkyEnvironment::irradianceMap.

skyEnvironmentFaceSize ​

cpp
int skyEnvironmentFaceSize

WeatherSkyEnvironment::environmentFaceSize.

skyIrradianceFaceSize ​

cpp
int skyIrradianceFaceSize

WeatherSkyEnvironment::irradianceFaceSize.

skyEnvironmentGenerationCount ​

cpp
uint64_t skyEnvironmentGenerationCount

WeatherSkyEnvironment::generationCount.

RaiSim — physics for robotics and AI.