Skip to content

godRay

const godRay: EffectDefinition<GodRayHandle, GodRayOptions>

Defined in: effects/src/godRay.ts:29

Animated god-rays / volumetric light shafts via pixi-filters’ GodrayFilter. The time uniform self-advances through the engine’s process scheduler on attach — pauses with the owning scene, time-scales with it. No caller-side step(dt) wiring required.

setIntensity scales the configured gain from 0 to its full value, so fadeIn ramps the rays in cleanly. setGain rebases the full value while preserving the current intensity ratio (mirrors bloom/outline/glow).