Skip to content

FfxCacaoSettings

struct FfxCacaoSettings

A structure for the settings used by FidelityFX CACAO. These settings may be updated with each draw call.

Public Interface

Public Members:

float radius

float radius

[0.0, ~ ] World (view) space size of the occlusion sphere.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 265, column 17)

float shadowMultiplier

float shadowMultiplier

[0.0, 5.0] Effect strength linear multiplier.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 266, column 17)

float shadowPower

float shadowPower

[0.5, 5.0] Effect strength pow modifier.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 267, column 17)

float shadowClamp

float shadowClamp

[0.0, 1.0] Effect max limit (applied after multiplier but before blur).

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 268, column 17)

float horizonAngleThreshold

float horizonAngleThreshold

[0.0, 0.2] Limits self-shadowing (makes the sampling area less of a hemisphere, more of a spherical cone, to avoid self-shadowing and various artifacts due to low tessellation and depth buffer imprecision, etc.).

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 269, column 17)

float fadeOutFrom

float fadeOutFrom

[0.0, ~ ] Distance to start fading out the effect.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 270, column 17)

float fadeOutTo

float fadeOutTo

[0.0, ~ ] Distance at which the effect is faded out.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 271, column 17)

FfxCacaoQuality qualityLevel

FfxCacaoQuality qualityLevel

Effect quality, affects number of taps etc.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 272, column 17)

float adaptiveQualityLimit

float adaptiveQualityLimit

[0.0, 1.0] (only for quality level FFX_CACAO_QUALITY_HIGHEST).

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 273, column 17)

uint32_t blurPassCount

uint32_t blurPassCount

[ 0, 8] Number of edge-sensitive smart blur passes to apply.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 274, column 17)

float sharpness

float sharpness

[0.0, 1.0] How much to bleed over edges; 1: not at all, 0.5: half-half; 0.0: completely ignore edges.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 275, column 17)

float temporalSupersamplingAngleOffset

float temporalSupersamplingAngleOffset

[0.0, PI] Used to rotate sampling kernel; If using temporal AA / supersampling, suggested to rotate by ( (frame%3)/3.0*PI ) or similar. Kernel is already symmetrical, which is why we use PI and not 2*PI.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 276, column 17)

float temporalSupersamplingRadiusOffset

float temporalSupersamplingRadiusOffset

[0.0, 2.0] Used to scale sampling kernel; If using temporal AA / supersampling, suggested to scale by ( 1.0f + (((frame%3)-1.0)/3.0)*0.1 ) or similar.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 277, column 17)

float detailShadowStrength

float detailShadowStrength

[0.0, 5.0] Used for high-res detail AO using neighboring depth pixels: adds a lot of detail but also reduces temporal stability (adds aliasing).

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 278, column 17)

bool generateNormals

bool generateNormals

This option should be set to FFX_CACAO_TRUE if FidelityFX-CACAO should reconstruct a normal buffer from the depth buffer. It is required to be FFX_CACAO_TRUE if no normal buffer is provided.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 279, column 17)

float bilateralSigmaSquared

float bilateralSigmaSquared

[0.0, ~ ] Sigma squared value for use in bilateral upsampler giving Gaussian blur term. Should be greater than 0.0.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 280, column 17)

float bilateralSimilarityDistanceSigma

float bilateralSimilarityDistanceSigma

[0.0, ~ ] Sigma squared value for use in bilateral upsampler giving similarity weighting for neighbouring pixels. Should be greater than 0.0.

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 281, column 17)

Used By: CacaoRM, FfxCacao

Source: sdk/include/FidelityFX/host/ffx_cacao.h (line 264, column 1)