LensRenderModule

Navigation: Samples → Effect samples → FidelityFX Lens sample

LensRenderModule

LensRenderModule Reference Documentation.

Functions

LensRenderModule

inline LensRenderModule()

Constructor with default behavior.

Attributes: inline

Source: samples/lens/lensrendermodule.h (line 65, column 5)

~LensRenderModule

virtual ~LensRenderModule()

Tear down the FFX API Context and release resources.

Attributes: virtual

Source: samples/lens/lensrendermodule.h (line 73, column 13)

Init

virtual void Init(const json &initData) override

Initialize FFX API Context, setup the intermediate color texture, and setup UI section for Lens.

Parameters:

Name	Type	Default
initData	const json &	“

Attributes: virtual

Source: samples/lens/lensrendermodule.h (line 78, column 10)

Execute

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

Setup input/output texture and parameters FFX API needs this frame and then call the FFX Dispatch.

Parameters:

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

Attributes: virtual

Source: samples/lens/lensrendermodule.h (line 83, 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/lens/lensrendermodule.h (line 88, column 10)

InitFfxContext

void InitFfxContext()

Source: samples/lens/lensrendermodule.h (line 92, column 10)

DestroyFfxContext

void DestroyFfxContext()

Source: samples/lens/lensrendermodule.h (line 94, column 10)

UpdateLensContext

void UpdateLensContext(bool enabled)

Destroy or re-create the FFX API Context.

Parameters:

Name	Type	Default
enabled	bool	“

Source: samples/lens/lensrendermodule.h (line 99, column 14)

Variables

int32_t m_LensMath

int32_t m_LensMath = = FFX_LENS_FLOAT_PRECISION_32BIT

Attributes: private

Source: samples/lens/lensrendermodule.h (line 101, column 25)

float m_grainScale

float m_grainScale = = 0.0f

Attributes: private

Source: samples/lens/lensrendermodule.h (line 103, column 11)

float m_grainAmount

float m_grainAmount = = 0.0f

Attributes: private

Source: samples/lens/lensrendermodule.h (line 104, column 11)

float m_chromAb

float m_chromAb = = 0.0f

Attributes: private

Source: samples/lens/lensrendermodule.h (line 105, column 11)

float m_vignette

float m_vignette = = 0.0f

Attributes: private

Source: samples/lens/lensrendermodule.h (line 106, column 11)

const double m_seedUpdateRate

const double m_seedUpdateRate = = 0.02

Attributes: private

Source: samples/lens/lensrendermodule.h (line 107, column 18)

const cauldron::Texture * m_pColorSrc

const cauldron::Texture * m_pColorSrc = = nullptr

Attributes: private

Source: samples/lens/lensrendermodule.h (line 110, column 36)

const cauldron::Texture * m_pColorIntermediate

const cauldron::Texture * m_pColorIntermediate = = nullptr

Attributes: private

Source: samples/lens/lensrendermodule.h (line 111, column 36)

FfxLensContextDescription m_InitializationParameters

FfxLensContextDescription m_InitializationParameters = = {}

Attributes: private

Source: samples/lens/lensrendermodule.h (line 114, column 31)

FfxLensContext m_LensContext

FfxLensContext m_LensContext

Attributes: private

Source: samples/lens/lensrendermodule.h (line 115, column 31)

bool m_ContextCreated

bool m_ContextCreated = = false

Attributes: private

Source: samples/lens/lensrendermodule.h (line 116, column 31)

Dependencies: FfxLensContext, FfxLensContextDescription