postProcessRenderPipelineManager.d.ts 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. import type { Camera } from "../../Cameras/camera";
  2. import type { PostProcessRenderPipeline } from "./postProcessRenderPipeline";
  3. /**
  4. * PostProcessRenderPipelineManager class
  5. * @see https://doc.babylonjs.com/features/featuresDeepDive/postProcesses/postProcessRenderPipeline
  6. */
  7. export declare class PostProcessRenderPipelineManager {
  8. private _renderPipelines;
  9. /**
  10. * Initializes a PostProcessRenderPipelineManager
  11. * @see https://doc.babylonjs.com/features/featuresDeepDive/postProcesses/postProcessRenderPipeline
  12. */
  13. constructor();
  14. /**
  15. * Gets the list of supported render pipelines
  16. */
  17. get supportedPipelines(): PostProcessRenderPipeline[];
  18. /**
  19. * Adds a pipeline to the manager
  20. * @param renderPipeline The pipeline to add
  21. */
  22. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  23. /**
  24. * Remove the pipeline from the manager
  25. * @param renderPipelineName the name of the pipeline to remove
  26. */
  27. removePipeline(renderPipelineName: string): void;
  28. /**
  29. * Attaches a camera to the pipeline
  30. * @param renderPipelineName The name of the pipeline to attach to
  31. * @param cameras the camera to attach
  32. * @param unique if the camera can be attached multiple times to the pipeline
  33. */
  34. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  35. /**
  36. * Detaches a camera from the pipeline
  37. * @param renderPipelineName The name of the pipeline to detach from
  38. * @param cameras the camera to detach
  39. */
  40. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  41. /**
  42. * Enables an effect by name on a pipeline
  43. * @param renderPipelineName the name of the pipeline to enable the effect in
  44. * @param renderEffectName the name of the effect to enable
  45. * @param cameras the cameras that the effect should be enabled on
  46. */
  47. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  48. /**
  49. * Disables an effect by name on a pipeline
  50. * @param renderPipelineName the name of the pipeline to disable the effect in
  51. * @param renderEffectName the name of the effect to disable
  52. * @param cameras the cameras that the effect should be disabled on
  53. */
  54. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  55. /**
  56. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  57. */
  58. update(): void;
  59. /** @internal */
  60. _rebuild(): void;
  61. /**
  62. * Disposes of the manager and pipelines
  63. */
  64. dispose(): void;
  65. }