class RenderModule

The FidelityFX Cauldron Framework render module base class.

File location: framework/cauldron/framework/inc/render/rendermodule.h

Construction

Return type

Description
RenderModule (const wchar_t* pName)
Construction. Does no setup.

Methods

Return type

Description

void
Init (const json& initData)
Rendermodule initialization function. This is where all setup code needs to happen.

void
EnableModule (bool enabled)
Sets the enabled state of the render module.

void
UpdateUI (double deltaTime)
Update the render module UI before Execution.

void
Execute (double deltaTime, CommandList * pCmdList) = 0
Executes the render module.

void
OnResize (const ResolutionInfo & resInfo)
Callback used when OnResize events occur.

void
OnFocusLost ()
Callback used when OnFocusLost events occur.

void
OnFocusGained ()
Callback used when OnFocusGained events occur.

void
OnPreFrame ()

bool
ModuleReady () const
Returns true if the render module is ready for execution.

bool
ModuleEnabled () const
Returns true if the render module is enabled.

const wchar_t*
GetName () const
Returns the render module name.

Detailed description

The FidelityFX Cauldron Framework render module base class. All render features inherit from this base class in order to execute gpu workloads.

Construction

RenderModule

Copied!

RenderModule (const wchar_t* pName)

Construction. Does no setup.

Methods

Init

Copied!

virtual void Init (const json& initData)

Rendermodule initialization function. This is where all setup code needs to happen.

EnableModule

Copied!

virtual void EnableModule (bool enabled)

Sets the enabled state of the render module.

UpdateUI

Copied!

virtual void UpdateUI (double deltaTime)

Update the render module UI before Execution.

Execute

Copied!

virtual void Execute (double deltaTime, CommandList * pCmdList) = 0

Executes the render module.

OnResize

Copied!

virtual void OnResize (const ResolutionInfo & resInfo)

Callback used when OnResize events occur.

OnFocusLost

Copied!

virtual void OnFocusLost ()

Callback used when OnFocusLost events occur.

OnFocusGained

Copied!

virtual void OnFocusGained ()

Callback used when OnFocusGained events occur.

ModuleReady

Copied!

bool ModuleReady () const

Returns true if the render module is ready for execution.

ModuleEnabled

Copied!

bool ModuleEnabled () const

Returns true if the render module is enabled.

GetName

Copied!

const wchar_t* GetName () const

Returns the render module name.