Api
Graphics
FogSetup
chevron_left Graphics
struct
FogSetup

Constructors

functionsFogSetup

Properties

data_objectAttenuationDistancedata_objectBaseHeightdata_objectColordata_objectDistanceEnableddata_objectEnableddata_objectEndDistancedata_objectFalloffExponentdata_objectHeightColordata_objectHeightEnableddata_objectHeightExponentdata_objectHeightFalloffdata_objectHeightSkyBlurdata_objectHeightSkyContributiondata_objectHeightSkyEncodingdata_objectHeightSkyRotationdata_objectHeightSkyTexturedata_objectMaxDistancedata_objectMaximumOpacitydata_objectModedata_objectSkyAffectdata_objectSkyBlurdata_objectSkyBlurDistanceEnableddata_objectSkyBlurDistanceRangedata_objectSkyBlurFardata_objectSkyContributiondata_objectSkyEncodingdata_objectSkyRotationdata_objectSkyTexturedata_objectStartDistancedata_objectSunFadeDistancedata_objectSunIntensitydata_objectSunLightingEnableddata_objectSunLobeWidthdata_objectSunSaturationdata_objectSunStartDistancedata_objectWeight
FogSetup
A camera's fog settings. A zero weight preserves both legacy fog layers; an enabled override replaces their combined result before volumetric fog is applied. Use <c>default(FogSetup)</c> to inherit legacy fog; <c>new FogSetup()</c> creates a full-weight override.
struct Sandbox.Rendering .
sealedSandbox.Engine

build Constructors 1

FogSetup ()
Creates a full-weight exponential fog override with default settings. A zero-initialized default(FogSetup) instead preserves legacy fog.

data_object Properties 36

AttenuationDistance
float
Distance removing 63.2 percent of background light, in world units.
BaseHeight
float
World height where the height gradient reaches full opacity.
Color
Color
Distance fog color and sky tint. Alpha is ignored; use MaximumOpacity instead.
DistanceEnabled
bool
Whether distance fog contributes, independently of height fog.
Enabled
bool
Whether this override adds fog. A disabled override with nonzero weight suppresses legacy fog.
EndDistance
float
Full-fog distance for the artistic distance model, in world units.
FalloffExponent
float
Exponent applied to the artistic distance ramp.
HeightColor
Color
Independent height fog color, with alpha controlling its maximum opacity.
HeightEnabled
bool
Enables the independent height gradient.
HeightExponent
float
Curve applied to the height gradient.
HeightFalloff
float
Signed world distance from full height fog to clear. Zero creates a hard boundary.
HeightSkyBlur
float
Cubemap blur, from the sharpest mip at zero to the coarsest mip at one.
HeightSkyContribution
float
Blend between constant color and the tinted cubemap, from zero to one.
HeightSkyEncoding
FogSkyEncoding
Color encoding stored in the sky cubemap. Ordinary HDR and RGB textures use Rgb.
HeightSkyRotation
Rotation
Rotation from world directions into the sky cubemap's local space.
HeightSkyTexture
Texture
Optional cubemap providing directional height fog color. Cube arrays use their first cube.
MaxDistance
float
Distance used to evaluate sky fog, independent of the camera's far clip plane.
MaximumOpacity
float
Upper limit on distance fog opacity, independent of color.
Mode
FogMode
Distance attenuation model.
SkyAffect
float
Additional opacity multiplier for sky pixels, from zero to one.
SkyBlur
float
Cubemap blur, from the sharpest mip at zero to the coarsest mip at one.
SkyBlurDistanceEnabled
bool
Use SkyBlur near the camera and SkyBlurFar beyond SkyBlurDistanceRange.
SkyBlurDistanceRange
Vector2
Start and end distances of the sky blur ramp, in world units.
SkyBlurFar
float
Far sky blur, from the sharpest mip at zero to the coarsest mip at one.
SkyContribution
float
Blend between constant color and the tinted cubemap, from zero to one.
SkyEncoding
FogSkyEncoding
Color encoding stored in the sky cubemap. Ordinary HDR and RGB textures use Rgb.
SkyRotation
Rotation
Rotation from world directions into the sky cubemap's local space.
SkyTexture
Texture
Optional cubemap providing directional fog color. Cube arrays use their first cube.
StartDistance
float
Clear distance before fog starts, in world units.
SunFadeDistance
float
Distance over which sun lighting smoothly fades in. Zero gives a hard start; negative values reverse the fade.
SunIntensity
float
Multiplier for the dominant sun's color, independent of its volumetric fog strength.
SunLightingEnabled
bool
Add an unshadowed glow from the view's dominant sun to distance fog.
SunLobeWidth
float
Angle from the sun at half intensity, in degrees.
SunSaturation
float
Sun glow saturation. Zero is greyscale, one preserves the light's color, and higher values strengthen it.
SunStartDistance
float
Distance from the camera where the sun glow starts fading in, in world units.
Weight
float
Influence over the legacy gradient and cubemap fog result, from zero to one.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.