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_endto inspect the full fog transition range.
Parameters
| No parameters are accepted by this function |
|---|
Returns
| Type | Name | Description |
|---|---|---|
float | result | Current depth begin value |
Examples
core.engine.print("info", "Fog depth begin:", gfx.fog.get_depth_begin())