API ReferenceGE ExtensionsClient
Caustics PostFX
Underwater caustic light patterns projected onto submerged surfaces.
Underwater caustic light patterns projected onto submerged surfaces.
Module Overview
| Property | Value |
|---|---|
| Source | lua/ge/client/postFx/caustics.lua |
| Returns | - (side-effect module) |
| Dependencies | PFX_DefaultStateBlock |
Scene Objects Created
| Object | Type | Description |
|---|---|---|
PFX_CausticsStateBlock | GFXStateBlockData | Additive blend (One + One), mixed sampling modes |
PFX_CausticsShader | ShaderData | caustics/causticsP.hlsl shader |
CausticsPFX | PostEffect | Caustics overlay, renders before translucent bin |
State Block Details
PFX_CausticsStateBlock
- Inherits
PFX_DefaultStateBlock - Additive blend:
GFXBlendOne+GFXBlendOne - Samplers: Clamp-Linear (0,1), Wrap-Linear (2,3)
PostEffect Configuration
| Property | Value |
|---|---|
| Render Time | PFXBeforeBin |
| Render Bin | ObjTranslucentBin |
| Enabled | false (disabled by default) |
| Texture 0 | #prepass[RT0] |
| Texture 1 | #prepass[Depth] |
| Texture 2 | lua/ge/client/postFx/textures/caustics_1.png |
| Texture 3 | lua/ge/client/postFx/textures/caustics_2.png |
| Target | $backBuffer |
Notes
- Uses two animated caustic textures that scroll/blend together.
- Additive blending adds light patterns on top of the scene.
- Depth-tested via prepass depth to only affect submerged geometry.
- Disabled by default; enabled when underwater or near water surfaces.
See Also
- client/postFx - PostFX manager