CacaoRenderModule

Navigation: Samples → Effect samples → FidelityFX CACAO sample

CacaoRenderModule

CacaoRenderModule Reference Documentation.

Functions

CACAORenderModule

inline CACAORenderModule()

Construct a new CACAORenderModule object.

Attributes: inline

Source: samples/cacao/cacaorendermodule.h (line 320, column 5)

~CACAORenderModule

virtual ~CACAORenderModule()

Destroy the CACAORenderModule object.

Attributes: virtual

Source: samples/cacao/cacaorendermodule.h (line 326, column 13)

Init

virtual void Init(const json &initData) override

Initialize the FFX API Context, setup CACAO settings to default, and setup the UI section for CACAO.

Parameters:

Name	Type	Default
`initData`	`const json &`	“

Attributes: virtual

Source: samples/cacao/cacaorendermodule.h (line 331, column 10)

EnableModule

virtual void EnableModule(bool enabled) override

If render module is enabled, initialize the FSR 1 API Context. If disabled, destroy the FSR 1 API Context.

Parameters:

Name	Type	Default
`enabled`	`bool`	“

Attributes: virtual

Source: samples/cacao/cacaorendermodule.h (line 336, column 10)

Execute

virtual void Execute(double deltaTime, cauldron::CommandList *pCmdList) override

Prepare input/output textures, parameters, and other resources necessary for the frame then call the FFX Dispatch.

Parameters:

Name	Type	Default
`deltaTime`	`double`	“
`pCmdList`	`cauldron::CommandList *`	“

Attributes: virtual

Source: samples/cacao/cacaorendermodule.h (line 341, column 10)

OnResize

virtual void OnResize(const cauldron::ResolutionInfo &resInfo) override

Called by the framework when resolution changes.

Parameters:

Name	Type	Default
`resInfo`	`const cauldron::ResolutionInfo &`	“

Attributes: virtual

Source: samples/cacao/cacaorendermodule.h (line 346, column 10)

SetOutputToCallbackTarget

void SetOutputToCallbackTarget(const bool outputToCallbackTarget)

If set to true, CACAO will output to the callback target to be presented to the screen. If set to false, it will output to the SSAO channel.

Parameters:

Name	Type	Default
`outputToCallbackTarget`	`const bool`	“

Source: samples/cacao/cacaorendermodule.h (line 351, column 10)

InitUI

void InitUI(cauldron::UISection *uiSection)

Init UI from master.

Parameters:

Name	Type	Default
`uiSection`	`cauldron::UISection *`	“

Source: samples/cacao/cacaorendermodule.h (line 356, column 10)

InitSdkContexts

void InitSdkContexts()

Source: samples/cacao/cacaorendermodule.h (line 388, column 10)

CreateCacaoContexts

void CreateCacaoContexts(const cauldron::ResolutionInfo &resInfo)

Parameters:

Name	Type	Default
`resInfo`	`const cauldron::ResolutionInfo &`	“

Source: samples/cacao/cacaorendermodule.h (line 390, column 10)

DestroyCacaoContexts

void DestroyCacaoContexts()

Source: samples/cacao/cacaorendermodule.h (line 392, column 10)

Variables

bool useDownsampledSsao

bool useDownsampledSsao

Source: samples/cacao/cacaorendermodule.h (line 44, column 6)

FfxCacaoSettings settings

FfxCacaoSettings settings

Source: samples/cacao/cacaorendermodule.h (line 45, column 18)

std::vector<const char *> s_FfxCacaoPresetNames

static std::vector<const char *> s_FfxCacaoPresetNames = = &#123;
  "Native - Adaptive Quality",
  "Native - High Quality",
  "Native - Medium Quality",
  "Native - Low Quality",
  "Native - Lowest Quality",
  "Downsampled - Adaptive Quality",
  "Downsampled - High Quality",
  "Downsampled - Medium Quality",
  "Downsampled - Low Quality",
  "Downsampled - Lowest Quality",
  "Custom"
&#125;

Attributes: static

Source: samples/cacao/cacaorendermodule.h (line 49, column 20)

const CacaoPreset s_FfxCacaoPresets

static const CacaoPreset s_FfxCacaoPresets

Attributes: static

Source: samples/cacao/cacaorendermodule.h (line 63, column 26)

const cauldron::Texture * m_pColorTarget

const cauldron::Texture * m_pColorTarget = = nullptr

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 361, column 36)

const cauldron::Texture * m_pCallbackColorTarget

const cauldron::Texture * m_pCallbackColorTarget = = nullptr

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 362, column 36)

const cauldron::Texture * m_pDepthTarget

const cauldron::Texture * m_pDepthTarget = = nullptr

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 363, column 36)

const cauldron::Texture * m_pNormalTarget

const cauldron::Texture * m_pNormalTarget = = nullptr

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 364, column 36)

const cauldron::RasterView * m_pColorRasterView

const cauldron::RasterView * m_pColorRasterView = = nullptr

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 367, column 32)

cauldron::SamplerDesc m_LinearSamplerDesc

cauldron::SamplerDesc m_LinearSamplerDesc

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 368, column 33)

cauldron::RootSignature * m_pPrepareOutputRS

cauldron::RootSignature * m_pPrepareOutputRS = = nullptr

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 369, column 32)

cauldron::PipelineObject * m_pPrepareOutputPipeline

cauldron::PipelineObject * m_pPrepareOutputPipeline = = nullptr

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 370, column 32)

cauldron::ParameterSet * m_pParamSet

cauldron::ParameterSet * m_pParamSet = = nullptr

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 371, column 32)

int32_t m_PresetId

int32_t m_PresetId = = _countof(s_FfxCacaoPresets)

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 374, column 30)

bool m_UseDownsampledSSAO

bool m_UseDownsampledSSAO = = false

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 375, column 30)

bool m_GenerateNormals

bool m_GenerateNormals = = false

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 376, column 30)

FfxCacaoSettings m_CacaoSettings

FfxCacaoSettings m_CacaoSettings

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 377, column 30)

FfxCacaoContext m_CacaoContext

FfxCacaoContext m_CacaoContext

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 378, column 30)

FfxCacaoContext m_CacaoDownsampledContext

FfxCacaoContext m_CacaoDownsampledContext

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 379, column 30)

bool m_ContextCreated

bool m_ContextCreated = = false

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 380, column 30)

bool m_OutputToCallbackTarget

bool m_OutputToCallbackTarget = = true

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 381, column 30)

std::vector<cauldron::UIElement *> m_UIElements

std::vector<cauldron::UIElement *> m_UIElements

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 384, column 17)

FfxInterface m_FfxInterface

FfxInterface m_FfxInterface = = &#123;0&#125;

Attributes: private

Source: samples/cacao/cacaorendermodule.h (line 386, column 18)

Dependencies

This module depends on: