GFXFog
gfx.fog.set_depth_end
Client
The depth end distance to be set for the fog post-processing effect
Syntax
local status = gfx.fog.set_depth_end(value)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 have no effect
- Recommended usage — set
depth_endgreater thandepth_beginto define a valid and visible fog transition range
Parameters
| Type | Name | Description |
|---|---|---|
float | value | Depth end value to be applied Sets the distance from the camera at which depth-based fog reaches full density. Geometry beyond this distance will be completely obscured by fog |
Returns
| Type | Name | Description |
|---|---|---|
bool | status | true on successful execution, or false on failure |
Examples
--Fully obscure geometry beyond 200 units
gfx.fog.set_depth_end(200.0)