gfx.fog.get_depth_end

Client

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


Syntax

local result = gfx.fog.get_depth_end()

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

Parameters

No parameters are accepted by this function

Returns

TypeNameDescription
floatresultCurrent depth end value

Examples

Print current fog depth end distance
core.engine.print("info", "Fog depth end:", gfx.fog.get_depth_end())

On this page