Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PostProcessRenderPipelineManager

Hierarchy

  • PostProcessRenderPipelineManager

Index

Constructors

constructor

Accessors

supportedPipelines

  • Gets the list of supported render pipelines

    Returns PostProcessRenderPipeline[]

Methods

addPipelineSearch playground for addPipeline

  • Adds a pipeline to the manager

    Parameters

    Returns void

attachCamerasToRenderPipelineSearch playground for attachCamerasToRenderPipeline

  • attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void
  • Attaches a camera to the pipeline

    Parameters

    • renderPipelineName: string

      The name of the pipeline to attach to

    • cameras: any | Camera[] | Camera

      the camera to attach

    • Optional unique: boolean

      if the camera can be attached multiple times to the pipeline

    Returns void

detachCamerasFromRenderPipelineSearch playground for detachCamerasFromRenderPipeline

  • detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void
  • Detaches a camera from the pipeline

    Parameters

    • renderPipelineName: string

      The name of the pipeline to detach from

    • cameras: any | Camera[] | Camera

      the camera to detach

    Returns void

disableEffectInPipelineSearch playground for disableEffectInPipeline

  • disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void
  • Disables an effect by name on a pipeline

    Parameters

    • renderPipelineName: string

      the name of the pipeline to disable the effect in

    • renderEffectName: string

      the name of the effect to disable

    • cameras: any | Camera[] | Camera

      the cameras that the effect should be disabled on

    Returns void

disposeSearch playground for dispose

  • dispose(): void
  • Disposes of the manager and pipelines

    Returns void

enableEffectInPipelineSearch playground for enableEffectInPipeline

  • enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void
  • Enables an effect by name on a pipeline

    Parameters

    • renderPipelineName: string

      the name of the pipeline to enable the effect in

    • renderEffectName: string

      the name of the effect to enable

    • cameras: any | Camera[] | Camera

      the cameras that the effect should be enabled on

    Returns void

updateSearch playground for update

  • update(): void
  • Updates the state of all contained render pipelines and disposes of any non supported pipelines

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method