DoFRenderModule

Navigation: Samples → Effect samples → FidelityFX Depth of Field sample

DoFRenderModule

DoFRenderModule Reference Documentation.

Functions

DoFRenderModule

inline DoFRenderModule()

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

Attributes: inline

Source: samples/dof/dofrendermodule.h (line 65, column 5)

~DoFRenderModule

virtual ~DoFRenderModule()

Destructs the FFX API context and releases resources.

Attributes: virtual

Source: samples/dof/dofrendermodule.h (line 71, column 13)

Init

virtual void Init(const json &initData) override

Initialize FFX API context and set up UI.

Parameters:

• initData (const json &) – Not used.

Attributes: virtual

Source: samples/dof/dofrendermodule.h (line 75, column 10)

UpdateUI

virtual void UpdateUI(double deltaTime) override

Update the DOF UI.

Parameters:

• deltaTime (double) – Not used.

Attributes: virtual

Source: samples/dof/dofrendermodule.h (line 79, column 18)

Execute

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

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

Parameters:

• deltaTime (double) – Not used.
• pCmdList (cauldron::CommandList *) – Command list on which to dispatch.

Attributes: virtual

Source: samples/dof/dofrendermodule.h (line 84, column 10)

OnResize

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

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

Parameters:

• resInfo (const cauldron::ResolutionInfo &) – New resolution info.

Attributes: virtual

Source: samples/dof/dofrendermodule.h (line 88, column 10)

SetupFidelityFxInterface

void SetupFidelityFxInterface()

Source: samples/dof/dofrendermodule.h (line 91, column 10)

UpdateDofContext

void UpdateDofContext(bool enabled)

Destroy or create the FFX API context using the currently set parameters.

Parameters:

Name	Type	Default
enabled	bool	“

Source: samples/dof/dofrendermodule.h (line 93, column 10)

DestroyDofContext

void DestroyDofContext()

Source: samples/dof/dofrendermodule.h (line 95, column 10)

Variables

float m_Aperture

float m_Aperture = = 0.01f

Attributes: private

Source: samples/dof/dofrendermodule.h (line 98, column 11)

float m_FocusDist

float m_FocusDist = = 2.0f

Attributes: private

Source: samples/dof/dofrendermodule.h (line 99, column 11)

float m_SensorSize

float m_SensorSize = = 0.02f

Attributes: private

Source: samples/dof/dofrendermodule.h (line 100, column 11)

float m_CocLimit

float m_CocLimit = = 0.01f

Attributes: private

Source: samples/dof/dofrendermodule.h (line 101, column 11)

int m_Quality

int m_Quality = = 10

Attributes: private

Source: samples/dof/dofrendermodule.h (line 102, column 11)

bool m_EnableRingMerge

bool m_EnableRingMerge = = false

Attributes: private

Source: samples/dof/dofrendermodule.h (line 103, column 11)

cauldron::UISection * m_UISection

cauldron::UISection * m_UISection = = nullptr

Attributes: private

Source: samples/dof/dofrendermodule.h (line 105, column 25)

cauldron::UISlider<float> * m_UIFocusDist

cauldron::UISlider<float> * m_UIFocusDist = = nullptr

Attributes: private

Source: samples/dof/dofrendermodule.h (line 106, column 24)

const cauldron::Texture * m_pColorTarget

const cauldron::Texture * m_pColorTarget = = nullptr

Attributes: private

Source: samples/dof/dofrendermodule.h (line 109, column 29)

const cauldron::Texture * m_pDepthTarget

const cauldron::Texture * m_pDepthTarget = = nullptr

Attributes: private

Source: samples/dof/dofrendermodule.h (line 110, column 29)

FfxDofContextDescription m_InitializationParameters

FfxDofContextDescription m_InitializationParameters = = {0}

Attributes: private

Source: samples/dof/dofrendermodule.h (line 113, column 30)

FfxDofContext m_DofContext

FfxDofContext m_DofContext

Attributes: private

Source: samples/dof/dofrendermodule.h (line 114, column 30)

Dependencies: FfxDofContext, FfxDofContextDescription