bloomMergePostProcess.d.ts 2.1 KB

1234567891011121314151617181920212223242526272829303132333435
  1. import type { PostProcessOptions } from "./postProcess";
  2. import { PostProcess } from "./postProcess";
  3. import type { Nullable } from "../types";
  4. import type { AbstractEngine } from "../Engines/abstractEngine";
  5. import type { Camera } from "../Cameras/camera";
  6. import "../Shaders/bloomMerge.fragment";
  7. /**
  8. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  9. */
  10. export declare class BloomMergePostProcess extends PostProcess {
  11. /** Weight of the bloom to be added to the original input. */
  12. weight: number;
  13. /**
  14. * Gets a string identifying the name of the class
  15. * @returns "BloomMergePostProcess" string
  16. */
  17. getClassName(): string;
  18. /**
  19. * Creates a new instance of @see BloomMergePostProcess
  20. * @param name The name of the effect.
  21. * @param originalFromInput Post process which's input will be used for the merge.
  22. * @param blurred Blurred highlights post process which's output will be used.
  23. * @param weight Weight of the bloom to be added to the original input.
  24. * @param options The required width/height ratio to downsize to before computing the render pass.
  25. * @param camera The camera to apply the render pass to.
  26. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  27. * @param engine The engine which the post process will be applied. (default: current engine)
  28. * @param reusable If the post process can be reused on the same frame. (default: false)
  29. * @param textureType Type of textures used when performing the post process. (default: 0)
  30. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  31. */
  32. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  33. /** Weight of the bloom to be added to the original input. */
  34. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: AbstractEngine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  35. }