Class SAO

Readonlyview

applied

• get applied(): boolean

  Gets if SAO is currently applied.

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

  Returns boolean

bias

• get bias(): number

  Gets the SAO bias.

  Default value is 0.5.

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

  Sets the SAO bias.

  Default value is 0.5.

  Parameters

  • value: number

  Returns void

blendCutoff

• get blendCutoff(): number

  Gets the SAO blend cutoff.

  Default value is 0.3.

  Normally you don't need to alter this.

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

  Sets the SAO blend cutoff.

  Default value is 0.3.

  Normally you don't need to alter this.

  Parameters

  • value: number

  Returns void

blendFactor

• get blendFactor(): number

  Gets the SAO blend scale.

  Default value is 1.0.

  Normally you don't need to alter this.

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

  Sets the SAO blend factor.

  Default value is 1.0.

  Normally you don't need to alter this.

  Parameters

  • value: number

  Returns void

blur

• get blur(): boolean

  Gets whether Guassian blur is enabled.

  Default value is true.

  Returns boolean
• set blur(value: boolean): void

  Sets whether Guassian blur is enabled.

  Default value is true.

  Parameters

  • value: boolean

  Returns void

enabled

• get enabled(): boolean

  Returns boolean

• set enabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

intensity

• get intensity(): number

  Gets the degree of darkening (ambient obscurance) produced by the SAO effect.

  Default value is 0.15.

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

  Sets the degree of darkening (ambient obscurance) produced by the SAO effect.

  Default value is 0.15.

  Parameters

  • value: number

  Returns void

kernelRadius

• get kernelRadius(): number

  Gets the maximum area that SAO takes into account when checking for possible occlusion for each fragment.

  Default value is 100.0.

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

  Sets the maximum area that SAO takes into account when checking for possible occlusion for each fragment.

  Default value is 100.0.

  Parameters

  • value: number

  Returns void

minResolution

• get minResolution(): number

  Gets the SAO minimum resolution.

  Default value is 0.0.

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

  Sets the SAO minimum resolution.

  Default value is 0.0.

  Parameters

  • value: number

  Returns void

numSamples

• get numSamples(): number

  Gets the number of SAO samples.

  Default value is 10.

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

  Sets the number of SAO samples.

  Default value is 10.

  Update this sparingly, since it causes a shader recompile.

  Parameters

  • value: number

  Returns void

scale

• get scale(): number

  Gets the SAO occlusion scale.

  Default value is 1.0.

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

  Sets the SAO occlusion scale.

  Default value is 1.0.

  Parameters

  • value: number

  Returns void

fromParams

• fromParams(saoParams: SAOParams): SDKResult<any>

  Configures this SAO.

  Parameters

  • saoParams: SAOParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<SAOParams>

  Gets the current configuration of this SAO.

  Returns SDKResult<SAOParams>