Export

Date

2022.9.15

Author

xwb

Hierarchy

Constructors

Properties

_blendFunction: BlendFunction
composer: EffectComposer
effect: SSREffect

Accessors

  • set blend(value): void
  • a value between 0 and 1 to set how much the last frame's reflections should be blended in; higher values will result in less noisy reflections when moving the camera but a more smeary look

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set blendFunction(value): void
  • 混合方式

    Parameters

    Returns void

    Memberof

    EffcetBase

  • set blur(value): void
  • how much the blurred reflections should be mixed with the raw reflections

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set blurKernel(value): void
  • kernel size of the Box Blur Filter; higher kernel sizes will result in blurrier reflections with more artifacts

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set blurSharpness(value): void
  • exponent of the Box Blur filter; higher values will result in more sharpness

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set correction(value): void
  • how much pixels should be corrected when doing temporal resolving; higher values will result in less smearing but more noise

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set correctionRadius(value): void
  • how many surrounding pixels will be used for neighborhood clamping; a higher value can reduce noise when moving the camera but will result in less performance

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set distance(value): void
  • maximum distance a reflection ray can travel to find what it reflects

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set dithering(value): void
  • 颜色抖动

    Parameters

    • value: boolean

    Returns void

    Memberof

    EffcetBase

  • set enable(value): void
  • 是否开启

    Parameters

    • value: boolean

    Returns void

    Memberof

    EffcetBase

  • set exponent(value): void
  • exponent by which reflections will be potentiated when composing the current frame's reflections and the accumulated reflections into a final reflection; higher values will make reflections clearer by highlighting darker spots less

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set fade(value): void
  • how much reflections will fade out by distance

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set intensity(value): void
  • intensity of the reflections

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set ior(value): void
  • Index of Refraction, used for calculating fresnel; reflections tend to be more intense the steeper the angle between them and the viewer is, the ior parameter sets how much the intensity varies

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set jitter(value): void
  • how intense jittering should be

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set jitterRoughness(value): void
  • how intense jittering should be in relation to a material's roughness

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set maxDepthDifference(value): void
  • maximum depth difference between a ray and the particular depth at its screen position after refining with binary search; higher values will result in better performance

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set maxRoughness(value): void
  • maximum roughness a texel can have to have reflections calculated for it

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set missedRays(value): void
  • if there should still be reflections for rays for which a reflecting point couldn't be found; enabling this will result in stretched looking reflections which can look good or bad depending on the angle

    Parameters

    • value: boolean

    Returns void

    Memberof

    SSR

  • set opacity(value): void
  • 透明度

    Parameters

    • value: number

    Returns void

    Memberof

    EffcetBase

  • set refineSteps(value): void
  • once we had our ray intersect something, we need to find the exact point in space it intersected and thus it reflects; this can be done through binary search with the given number of maximum steps

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set resolutionScale(value): void
  • resolution of the SSR effect, a resolution of 0.5 means the effect will be rendered at half resolution

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set roughnessFade(value): void
  • how intense reflections should be on rough spots; a higher value will make reflections fade out quicker on rough spots

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set steps(value): void
  • number of steps a reflection ray can maximally do to find an object it intersected (and thus reflects)

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set thickness(value): void
  • maximum depth difference between a ray and the particular depth at its screen position before refining with binary search; higher values will result in better performance

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

  • set useNormalMap(value): void
  • if normal maps should be taken account of when calculating reflections

    Parameters

    • value: boolean

    Returns void

    Memberof

    SSR

  • set useRoughnessMap(value): void
  • if roughness maps should be taken account of when calculating reflections

    Parameters

    • value: boolean

    Returns void

    Memberof

    SSR

  • set velocityResolutionScale(value): void
  • resolution of the velocity buffer, a resolution of 0.5 means velocity will be rendered at half resolution

    Parameters

    • value: number

    Returns void

    Memberof

    SSR

Methods

  • Protected

    加载图片

    Parameters

    • url: string

    Returns Promise<Texture>

    {Promise}

    Memberof

    EffcetBase

  • 调整环境贴图强度

    Parameters

    • value: number

    Returns void

    Memberof

    SSR