filament/io.github.erkko68.filament/AmbientOcclusionOptions

AmbientOcclusionOptions

class AmbientOcclusionOptions

Options for screen space Ambient Occlusion (SSAO) and Screen Space Cone Tracing (SSCT).

Ambient occlusion darkens crevices and contact points, adding realism and depth to scenes.

Constructors

constructor()

Types

AmbientOcclusionType

enum AmbientOcclusionType : Enum<AmbientOcclusionOptions.AmbientOcclusionType>

The occlusion algorithm to use.

Gtao

class Gtao

Ground-Truth-based Ambient Occlusion options.

Ssct

class Ssct

Screen Space Cone Tracing options for ambient shadows.

Properties

aoType

var aoType: AmbientOcclusionOptions.AmbientOcclusionType

Type of ambient occlusion algorithm. Default: AmbientOcclusionType.SAO.

bentNormals

var bentNormals: Boolean

Enable bent normals computation from AO, and specular AO. Default: false.

bias

var bias: Float

Self-occlusion bias in meters. Use to avoid self-occlusion. Between 0 and a few mm. No effect when aoType is set to GTAO. Default: 0.0005.

bilateralThreshold

var bilateralThreshold: Float

Depth distance that constitutes an edge for filtering. Default: 0.05.

enabled

var enabled: Boolean

Enable or disable screen-space ambient occlusion. Default: false.

gtao

var gtao: AmbientOcclusionOptions.Gtao

Ground-Truth-based Ambient Occlusion tuning. Only takes effect when aoType is AmbientOcclusionType.GTAO.

intensity

var intensity: Float

Strength of the Ambient Occlusion effect. Default: 1.0.

lowPassFilter

var lowPassFilter: QualityLevel

Affects AO smoothness. Recommended setting to HIGH when aoType is set to GTAO. Default: MEDIUM.

minHorizonAngleRad

var minHorizonAngleRad: Float

Minimum angle in radians to consider. No effect when aoType is set to GTAO. Default: 0.0.

power

var power: Float

Controls ambient occlusion's contrast. Must be positive. Default: 1.0.

quality

var quality: QualityLevel

Affects number of samples used for AO and parameters for filtering. Default: LOW.

radius

var radius: Float

Ambient Occlusion radius in meters, between 0 and ~10. Default: 0.3.

resolution

var resolution: Float

How each dimension of the AO buffer is scaled. Must be either 0.5 or 1.0. Default: 0.5.

ssct

var ssct: AmbientOcclusionOptions.Ssct

Screen Space Cone Tracing (SSCT) options for ambient shadows from dominant light.

upsampling

var upsampling: QualityLevel

Affects AO buffer upsampling quality. Default: LOW.