Class EffectRenderer

constructor

• new EffectRenderer(
      engine: AbstractEngine,
      options?: IEffectRendererOptions,
  ): EffectRenderer

  Creates an effect renderer

  Parameters

  • engine: AbstractEngine

    the engine to use for rendering

  • options: IEffectRendererOptions = DefaultOptions

    defines the options of the effect renderer

  Returns EffectRenderer

Readonlyengine

applyEffectWrapper

• applyEffectWrapper(
      effectWrapper: EffectWrapper,
      depthTest?: boolean,
      stencilTest?: boolean,
  ): void

  Sets the current effect wrapper to use during draw. The effect needs to be ready before calling this api. This also sets the default full screen position attribute.

  Parameters

  • effectWrapper: EffectWrapper

    Defines the effect to draw with

  • depthTest: boolean = false

    Whether to enable depth testing (default: false)

  • stencilTest: boolean = false

    Whether to enable stencil testing (default: false)

  Returns void

bindBuffers

• bindBuffers(effect: Effect): void

  Binds the embedded attributes buffer to the effect.

  Parameters

  • effect: Effect

    Defines the effect to bind the attributes for

  Returns void

dispose

• dispose(): void

  Disposes of the effect renderer

  Returns void

draw

• draw(): void

  Draws a full screen quad.

  Returns void

render

• render(
      effectWrapper: EffectWrapper,
      outputTexture?: Nullable<RenderTargetWrapper | IRenderTargetTexture>,
  ): void

  renders one or more effects to a specified texture

  Parameters

  • effectWrapper: EffectWrapper

    the effect to renderer

  • outputTexture: Nullable<RenderTargetWrapper | IRenderTargetTexture> = null

    texture to draw to, if null it will render to the currently bound frame buffer

  Returns void

restoreStates

• restoreStates(): void

  Restores engine states

  Returns void

saveStates

• saveStates(): void

  Saves engine states

  Returns void

setViewport

• setViewport(viewport?: Viewport): void

  Sets the current viewport in normalized coordinates 0-1

  Parameters

  • viewport: Viewport = ...

    Defines the viewport to set (defaults to 0 0 1 1)

  Returns void