Vital.sandbox

gfx.fog.get_depth_curve

Client

Retrieves the current depth curve of the fog post-processing effect


Syntax

local result = gfx.fog.get_depth_curve()

Only available when the fog mode is set to depth mode. Refer gfx.fog.set_mode to configure the active fog mode.

  • Depth mode required — calling this function in any other fog mode will return an unexpected result.
  • Recommended usage — use alongside gfx.fog.get_depth_begin and gfx.fog.get_depth_end to inspect the complete fog transition profile.

Parameters

No parameters are accepted by this function

Returns

TypeNameDescription
floatresultCurrent depth curve value

Examples

Print current fog depth curve
core.engine.print("info", "Fog depth curve:", gfx.fog.get_depth_curve())

gfx.fog.get_sky_affect

Retrieves the current sky influence amount of the fog post-processing effect

gfx.fog.get_depth_begin

Retrieves the current depth begin distance of the fog post-processing effect

On this page

SyntaxParametersReturnsExamples