API ReferenceGE ExtensionsClient
PostFx Turbulence Effect
Screen-space turbulence distortion post-processing effect. Applies a heat-haze or ripple distortion to the back buffer.
Screen-space turbulence distortion post-processing effect. Applies a heat-haze or ripple distortion to the back buffer.
Overview
Declarative setup script (no M module). Registers:
PFX_TurbulenceStateBlock- Z-disabled, linear clamp samplerPFX_TurbulenceShader- Turbulence distortion pixel shaderTurbulenceFx- PostEffect (disabled by default, priority 0.5)
Scene Objects
| Object | Type | Default Enabled | Priority | Description |
|---|---|---|---|---|
TurbulenceFx | PostEffect | false | 0.5 | Screen turbulence distortion |
PFX_TurbulenceStateBlock | GFXStateBlockData | - | - | Z-test disabled, linear clamp sampler |
PFX_TurbulenceShader | ShaderData | - | - | Turbulence pixel shader |
Configuration
-- Turbulence renders after glow objects but before other post effects
turbulenceFx:setField("renderTime", 0, "PFXAfterBin")
turbulenceFx:setField("renderBin", 0, "GlowBin")
turbulenceFx.renderPriority = 0.5 -- Renders after the glows themselvesNotes
- Unlike most PostFx effects, this one allows reflection passes (
allowReflectPass = true) - Renders after
GlowBinwith priority 0.5 (after glow at priority 1) - Z-buffer testing and writing are both disabled
- Reads from
$backBuffer - The effect is disabled by default and must be explicitly enabled
Usage Example
-- Enable turbulence effect (e.g., near heat sources)
local turbFx = scenetree.findObject("TurbulenceFx")
if turbFx then turbFx:enable() endSee Also
- PostFx Glow - Glow/bloom (shares GlowBin)
- PostFx Flash - Screen flash overlay
PostFx SSAO (Screen-Space Ambient Occlusion)
Dual-radius screen-space ambient occlusion effect. Provides small-radius detail occlusion and large-radius contact shadows with configurable quality levels.
PostFx Utilities
Utility module for loading and saving post-processing effect preset files via file dialogs.