Vital.sandbox
GFXFog

gfx.fog.set_mode

Client

The fog mode to be set for the fog post-processing effect


Syntax

local status = gfx.fog.set_mode(value)

Parameters

TypeNameDescription
intvalueFog mode to be applied. Determines how fog density is calculated across the scene:
0 - Exponential mode, fog density increases exponentially with distance from the camera
1 - Depth mode, fog is applied based on a defined depth range with configurable start and end points

Returns

TypeNameDescription
boolstatustrue on successful execution, or false on failure

Examples

Set exponential and depth-based fog modes
--Set exponential fog mode
gfx.fog.set_mode(0)

--Set depth-based fog mode
gfx.fog.set_mode(1)

On this page