Class FilterSampler

manager

name

onRunBegin

• onRunBegin(drawingContext: DrawingContext): void

  By default this is an empty method hook that you can override and use in your own custom render nodes.

  This method is called at the start of the run method. Don't forget to call it in your custom method.

  Parameters

  • drawingContext: DrawingContext

    The context currently in use.

  Returns void

onRunEnd

• onRunEnd(drawingContext: DrawingContext): void

  By default this is an empty method hook that you can override and use in your own custom render nodes.

  This method is called at the end of the run method. Don't forget to call it in your custom method.

  Parameters

  • drawingContext: DrawingContext

    The context currently in use.

  Returns void

run

• run(
      controller: Controller,
      inputDrawingContext: DrawingContext,
      outputDrawingContext?: DrawingContext,
      padding?: Geom.Rectangle,
  ): DrawingContext

  Run the filter. It returns a drawing context containing the output texture.

  Parameters

  • controller: Controller

    The filter controller.
  • inputDrawingContext: DrawingContext

    The drawing context containing the input texture. This is either the initial render, or the output of the previous filter. This will be released during the run process, and can no longer be used.
  • OptionaloutputDrawingContext: DrawingContext

    The drawing context where the output texture will be drawn. If not specified, a new drawing context will be generated. Generally, this parameter is used for the last filter in a chain, so the output texture is drawn to the main framebuffer.
  • Optionalpadding: Geom.Rectangle

    The padding to add to the input texture to create the output texture. If not specified, the controller is used to get the padding. This should be undefined for internal filters, so the controller will expand textures as needed; and defined as the negative padding of the previous filter for external filters, so the texture will shrink to the correct size.

  Returns DrawingContext

setDebug

• setDebug(debug: boolean): void

  Set whether the node should report debug information. It wraps the run method with additional debug information.

  Parameters

  • debug: boolean

    Whether to report debug information.

  Returns void