GFXFog
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_beginandgfx.fog.get_depth_endto inspect the complete fog transition profile
Parameters
| Type | Name | Description |
|---|
Returns
| Type | Name | Description |
|---|---|---|
float | result | Current depth curve value |
Examples
engine.print("info", "Fog depth curve:", gfx.fog.get_depth_curve())