Vital.sandbox
GFXFog

gfx.fog.get_depth_begin

Client

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


Syntax

local result = gfx.fog.get_depth_begin()

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_end to inspect the full fog transition range

Parameters

TypeNameDescription

Returns

TypeNameDescription
floatresultCurrent depth begin value

Examples

Print current fog depth begin distance
engine.print("info", "Fog depth begin:", gfx.fog.get_depth_begin())

gfx.fog.set_depth_begin

The depth begin distance to be set for the fog post-processing effect

gfx.fog.set_depth_end

The depth end distance to be set for the fog post-processing effect

On this page

SyntaxParametersReturnsExamples