screenSpaceCurvaturePostProcess.d.ts 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. import type { Nullable } from "../types";
  2. import type { Camera } from "../Cameras/camera";
  3. import type { PostProcessOptions } from "./postProcess";
  4. import { PostProcess } from "./postProcess";
  5. import "../Rendering/geometryBufferRendererSceneComponent";
  6. import "../Shaders/screenSpaceCurvature.fragment";
  7. import type { AbstractEngine } from "../Engines/abstractEngine";
  8. import type { Scene } from "../scene";
  9. /**
  10. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  11. */
  12. export declare class ScreenSpaceCurvaturePostProcess extends PostProcess {
  13. /**
  14. * Defines how much ridge the curvature effect displays.
  15. */
  16. ridge: number;
  17. /**
  18. * Defines how much valley the curvature effect displays.
  19. */
  20. valley: number;
  21. private _geometryBufferRenderer;
  22. /**
  23. * Gets a string identifying the name of the class
  24. * @returns "ScreenSpaceCurvaturePostProcess" string
  25. */
  26. getClassName(): string;
  27. /**
  28. * Creates a new instance ScreenSpaceCurvaturePostProcess
  29. * @param name The name of the effect.
  30. * @param scene The scene containing the objects to blur according to their velocity.
  31. * @param options The required width/height ratio to downsize to before computing the render pass.
  32. * @param camera The camera to apply the render pass to.
  33. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  34. * @param engine The engine which the post process will be applied. (default: current engine)
  35. * @param reusable If the post process can be reused on the same frame. (default: false)
  36. * @param textureType Type of textures used when performing the post process. (default: 0)
  37. * @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)
  38. */
  39. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: AbstractEngine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40. /**
  41. * Support test.
  42. */
  43. static get IsSupported(): boolean;
  44. /**
  45. * @internal
  46. */
  47. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  48. }