Class DepthOfField

Readonlyview

applied

• get applied(): boolean

  Gets if depth of field is currently applied.

  This is true when the component enabled state is in the component enabled state.

  Returns boolean

enabled

• get enabled(): boolean

  Returns boolean

• set enabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

farBlur

• get farBlur(): number

  Blur multiplier for geometry farther than focusDistance. Default 1.0.

  Returns number
• set farBlur(value: number): void

  Parameters

  • value: number

  Returns void

focalRange

• get focalRange(): number

  Distance band around focusDistance that remains mostly sharp. Default 20.

  Returns number
• set focalRange(value: number): void

  Parameters

  • value: number

  Returns void

focusDistance

• get focusDistance(): number

  View-space distance, in world units, that remains sharp. Default 50.

  Returns number
• set focusDistance(value: number): void

  Parameters

  • value: number

  Returns void

intensity

• get intensity(): number

  Overall blend strength for the blurred result. Default 0.75.

  Returns number
• set intensity(value: number): void

  Parameters

  • value: number

  Returns void

nearBlur

• get nearBlur(): number

  Blur multiplier for geometry nearer than focusDistance. Default 0.25.

  Returns number
• set nearBlur(value: number): void

  Parameters

  • value: number

  Returns void

radius

• get radius(): number

  Maximum blur radius in scene pixels. Default 4.

  Returns number
• set radius(value: number): void

  Parameters

  • value: number

  Returns void

fromParams

• fromParams(params: DepthOfFieldParams): SDKResult<any>

  Configures this DepthOfField.

  Parameters

  • params: DepthOfFieldParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<DepthOfFieldParams>

  Gets this DepthOfField as JSON.

  Returns SDKResult<DepthOfFieldParams>