class CACAORenderModule

This RenderModule using the depth, color, and optionally normal targets performs SSAO and outputs it to the color target.

File location: samples/cacao/cacaorendermodule.h

Construction

Return type

Description

Construct a new CACAORenderModule object.

Methods

Return type

Description

void

Init (const json& initData)
Initialize the FFX API Context, setup CACAO settings to default, and setup the UI section for CACAO.

void

EnableModule (bool enabled)
If render module is enabled, initialize the FSR 1 API Context. If disabled, destroy the FSR 1 API Context.

void

Execute (double deltaTime, cauldron::CommandList * pCmdList)
Prepare input/output textures, parameters, and other resources necessary for the frame then call the FFX Dispatch.

void

Called by the framework when resolution changes.

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.

void

Init UI from master.

Detailed description

This RenderModule using the depth, color, and optionally normal targets performs SSAO and outputs it to the color target. It also creates a UI section enabling users to modify the settings used for CACAO.

Construction

CACAORenderModule

Copied!

CACAORenderModule ()

Construct a new CACAORenderModule object.


Methods

Init

Copied!

virtual void Init (const json& initData)

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


EnableModule

Copied!

virtual void EnableModule (bool enabled)

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


Execute

Copied!

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

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


OnResize

Copied!

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

Called by the framework when resolution changes.


SetOutputToCallbackTarget

Copied!

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.


InitUI

Copied!

void InitUI (cauldron::UISection * uiSection)

Init UI from master.


Related pages

  • Visit the FidelityFX SDK product page for download links and more information.

Looking for more documentation on GPUOpen?

AMD GPUOpen software blogs

Our handy software release blogs will help you make good use of our tools, SDKs, and effects, as well as sharing the latest features with new releases.

GPUOpen Manuals

Don’t miss our manual documentation! And if slide decks are what you’re after, you’ll find 100+ of our finest presentations here.

AMD GPUOpen Performance Guides

The home of great performance and optimization advice for AMD RDNAâ„¢ 2 GPUs, AMD Ryzenâ„¢ CPUs, and so much more.

Getting started: AMD GPUOpen software

New or fairly new to AMD’s tools, libraries, and effects? This is the best place to get started on GPUOpen!

AMD GPUOpen Getting Started Development and Performance

Looking for tips on getting started with developing and/or optimizing your game, whether on AMD hardware or generally? We’ve got you covered!

AMD GPUOpen Technical blogs

Browse our technical blogs, and find valuable advice on developing with AMD hardware, ray tracing, Vulkan®, DirectX®, Unreal Engine, and lots more.

Find out more about our software!

AMD GPUOpen Effects - AMD FidelityFX technologies

Create wonder. No black boxes. Meet the AMD FidelityFX SDK!

AMD GPUOpen Samples

Browse all our useful samples. Perfect for when you’re needing to get started, want to integrate one of our libraries, and much more.

AMD GPUOpen developer SDKs

Discover what our SDK technologies can offer you. Query hardware or software, manage memory, create rendering applications or machine learning, and much more!

AMD GPUOpen Developer Tools

Analyze, Optimize, Profile, Benchmark. We provide you with the developer tools you need to make sure your game is the best it can be!