Type Alias VFXPostEffect

VFXPostEffect: {
    shader: ShaderPreset | string;
    uniforms?: VFXUniforms;
    backbuffer?: boolean;
}

Configuration for post effects that are applied to the final canvas output.

Type declaration

  • shader: ShaderPreset | string

    Fragment shader code or preset name to be applied as a post effect.
    You can pass a preset name from ShaderPreset (e.g., "invert", "grayscale", "sepia")
    or provide custom shader code.

    The shader will receive the rendered canvas as a sampler2D src uniform.

    Standard uniforms available:

    • sampler2D src: The input texture (rendered canvas)
    • vec2 resolution: Canvas resolution in pixels
    • vec2 offset: Offset values
    • vec4 viewport: Viewport information
    • float time: Time in seconds since VFX started
    • vec2 mouse: Mouse position in pixels
    • sampler2D backbuffer: Previous frame texture (if backbuffer is enabled)
  • Optionaluniforms?: VFXUniforms

    Custom uniform values to be passed to the post effect shader.
    Works the same way as element uniforms.

  • Optionalbackbuffer?: boolean

    Whether the post effect should use a backbuffer for feedback effects.
    When enabled, the previous frame's output is available as sampler2D backbuffer.