API Docs for:
Show:

CircularDistortionEffect Class

Module: gs

An effect collection stores all effects by name. So if you add custom effects, you have to create an own class and inherit from gs.EffectCollection and add your own effects in the constructor. It is important to put the super-call at the end and not at the beginning.

Item Index

Methods

Properties

Methods

register

()

Called before the graphics system is initialized to register your custom shader-based effect. See gs.Main.setupEffects for more info.

setup

(
  • effect
  • task
  • texture
)

Setup the effect for rendering. All uniforms/shader-inputs need to be set here.

Parameters:

  • effect gs.Effect
    • The shader-effect/program object which allows you to set uniforms.
  • task gs.RenderTask
    • The render-task object contains additional information about the object being rendered.
  • texture gs.Texture2D
    • The texture used for rendering.

Properties

circularDistortion

gs.CircularDistortionEffect

A circular distortion effect.