Vital.sandbox
GFXFog

gfx.fog.set_height_density

Client

The height density to be set for the fog post-processing effect


Syntax

local status = gfx.fog.set_height_density(value)

Parameters

TypeNameDescription
floatvalueHeight density value to be applied
Controls how quickly fog density increases as height decreases. Use a negative value to instead increase fog density as height increases

Returns

TypeNameDescription
boolstatustrue on successful execution, or false on failure

Examples

Increase fog density toward the ground
--Increase fog density toward the ground
gfx.fog.set_height_density(10.0)
Increase fog density toward the sky
--Increase fog density toward the sky
gfx.fog.set_height_density(-10.0)

On this page