class DoFRenderModule

DOFRenderModule handles a number of tasks related to DOF.

File location: samples/dof/dofrendermodule.h

Construction

Return type

Description

Constructor with default behavior. Initializes parameters to sensible defaults for metric unit systems.

Methods

Return type

Description

void

Init (const json& initData)
Initialize FFX API context and set up UI.

void

UpdateUI (double deltaTime)
Update the DOF UI.

void

Execute (double deltaTime, cauldron::CommandList * pCmdList)
Dispatch the DOF effect using FFX API and update the Focus Distance slider range according to the scene bounds.

void

Recreate the FFX API context to resize internal resources. Called by the framework when the resolution changes.

Detailed description

DOFRenderModule handles a number of tasks related to DOF.

DoFRenderModule takes care of:

  • creating UI section that enable users to select DoF quality and lens model options

  • applying depth of field to the color target

Construction

DoFRenderModule

Copied!

DoFRenderModule ()

Constructor with default behavior. Initializes parameters to sensible defaults for metric unit systems.


Methods

Init

Copied!

virtual void Init (const json& initData)

Initialize FFX API context and set up UI.

Parameters:

initData

Not used.


UpdateUI

Copied!

virtual void UpdateUI (double deltaTime)

Update the DOF UI.

Parameters:

deltaTime

Not used.


Execute

Copied!

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

Dispatch the DOF effect using FFX API and update the Focus Distance slider range according to the scene bounds.

Parameters:

deltaTime

Not used.

pCmdList

Command list on which to dispatch.


OnResize

Copied!

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

Recreate the FFX API context to resize internal resources. Called by the framework when the resolution changes.

Parameters:

resInfo

New resolution info.