Options
All
  • Public
  • Public/Protected
  • All
Menu

Contains all parameters needed for the prepass to perform screen space subsurface scattering

Hierarchy

  • SubSurfaceConfiguration

Implements

Index

Constructors

  • Builds a subsurface configuration object

    Parameters

    Returns SubSurfaceConfiguration

Properties

enabled: boolean

Is subsurface enabled

metersPerUnit: number

Defines the ratio real world => scene units. Used for subsurface scattering

name: string

Name of the configuration

needsImageProcessing: boolean

Does the output of this prepass need to go through imageprocessing

Post process to attach for screen space subsurface scattering

ssDiffusionProfileColors: Color3[]

Diffusion profile colors for subsurface scattering You can add one diffusion color using addDiffusionProfile on scene.prePassRenderer See ... Note that you can only store up to 5 of them

texturesRequired: number[]

Textures that should be present in the MRT for this effect to work

Accessors

  • get ssDiffusionD(): number[]
  • Diffusion profile max color channel value for subsurface scattering

    Returns number[]

  • get ssDiffusionS(): number[]
  • Diffusion profile color for subsurface scattering

    Returns number[]

  • get ssFilterRadii(): number[]
  • Diffusion profile filter radius for subsurface scattering

    Returns number[]

Methods

  • addDiffusionProfile(color: Color3): number
  • Adds a new diffusion profile. Useful for more realistic subsurface scattering on diverse materials.

    Parameters

    • color: Color3

      The color of the diffusion profile. Should be the average color of the material.

    Returns number

    The index of the diffusion profile for the material subsurface configuration

  • clearAllDiffusionProfiles(): void
  • Deletes all diffusion profiles. Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.

    Returns void

  • dispose(): void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme