Base class for denoiser implementations. More...

Inheritance diagram for foray::stages::DenoiserStage:

Public Member Functions
virtual void	Init (core::Context *context, const DenoiserConfig &config)

virtual void	UpdateConfig (const DenoiserConfig &config)

virtual std::string	GetUILabel ()
	Get the UI label used for user facing labelling of the denoiser.

virtual void	DisplayImguiConfiguration ()
	Record the ImGui commands for configuration of the denoiser.

virtual void	IgnoreHistoryNextFrame ()
	Signals the denoiser stage that history information is to be ignored for the coming frame.

Public Member Functions inherited from foray::stages::RenderStage
	RenderStage ()=default

virtual void	RecordFrame (VkCommandBuffer cmdBuffer, base::FrameRenderInfo &renderInfo)
	Records a frame to cmdBuffer.

virtual void	Destroy ()
	Destroy the render stage. Finalizes all components.

virtual void	Resize (const VkExtent2D &extent)
	Default implementation accesses mImageOutputs and calls ManagedImage::Resize(extent) on any set image.

std::vector< core::ManagedImage * >	GetImageOutputs ()
	Gets a vector to all color attachments that will be included in a texture array and can be referenced in the shader pass.

core::ManagedImage *	GetImageOutput (std::string_view name, bool noThrow=false)
	Gets an image output.

virtual void	OnShadersRecompiled (const std::unordered_set< uint64_t > &recompiled)
	Notifies the stage that the shader compiler instance has recompiled a shader.

virtual	~RenderStage ()

Additional Inherited Members
Protected Member Functions inherited from foray::stages::RenderStage
virtual void	ReloadShaders ()
	Override this to reload all shaders and rebuild pipelines after a registered shader has been recompiled.

virtual void	DestroyOutputImages ()
	Calls Destroy() on any image in mImageOutputs and clears mImageOutputs.

Protected Attributes inherited from foray::stages::RenderStage
std::unordered_map< std::string, core::ManagedImage * >	mImageOutputs
	Inheriting types should emplace their images onto this collection to provide them in GetImageOutput interface.

std::vector< uint64_t >	mShaderKeys
	Inheriting types should emplace their shader keys onto this collection such that if a shader has been recompiled, ReloadShaders() will be called.

core::Context *	mContext = nullptr
	Context object the renderstage is built upon.

Detailed Description

Base class for denoiser implementations.

Member Function Documentation

virtual void foray::stages::DenoiserStage::DisplayImguiConfiguration ( )

inlinevirtual

Record the ImGui commands for configuration of the denoiser.

virtual std::string foray::stages::DenoiserStage::GetUILabel ( )

inlinevirtual

Get the UI label used for user facing labelling of the denoiser.

virtual void foray::stages::DenoiserStage::IgnoreHistoryNextFrame ( )

inlinevirtual

Signals the denoiser stage that history information is to be ignored for the coming frame.

virtual void foray::stages::DenoiserStage::Init	(	core::Context *	context,
		const DenoiserConfig &	config
	)

inlinevirtual

virtual void foray::stages::DenoiserStage::UpdateConfig ( const DenoiserConfig & config )

inlinevirtual

The documentation for this class was generated from the following file: