castor3d::ToneMapping Class Reference

#include <ToneMapping.hpp>

Inheritance diagram for castor3d::ToneMapping:

Collaboration diagram for castor3d::ToneMapping:

Public Member Functions
C3D_API	ToneMapping (Engine &engine, crg::FramePassGroup &graph, crg::ImageViewIdArray const &source, crg::ImageViewId const &target, crg::FramePass const &previousPass, HdrConfigUbo &hdrConfigUbo, ColourGradingUbo &colourGradingUbo, ProgressBar *progress)
	Specified constructor.
C3D_API void	initialise (castor::String const &name, crg::ImageViewId const &source)
	Initialises tone mapping shader and pipeline.
C3D_API void	update (CpuUpdater &updater, crg::ImageViewId const &source)
C3D_API void	updatePipeline (castor::String const &name)
	Initialises tone mapping shader and pipeline.
C3D_API void	accept (ToneMappingVisitor &visitor)
	Visitor acceptance function.
C3D_API castor::String const &	getFullName () const
crg::FramePass const &	getPass () const noexcept
castor::String const &	getName () const noexcept
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const

Static Public Member Functions
static C3D_API void	getVertexProgram (ast::ShaderBuilder &builder)
	Retrieves the vertex shader for tone mapping.

Protected Attributes
castor::String	m_name { cuT( "linear" ) }
HdrConfigUbo &	m_hdrConfigUbo
ColourGradingUbo &	m_colourGradingUbo
castor3d::ProgramModule	m_shader { cuT( "ToneMapping" ) }
crg::ImageViewId	m_source
ashes::PipelineShaderStageCreateInfoArray	m_program
crg::FramePass *	m_pass {}
crg::RenderQuad *	m_quad {}
uint32_t	m_passIndex {}

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructor.

Constructor & Destructor Documentation

ToneMapping()

C3D_API castor3d::ToneMapping::ToneMapping	(	Engine &	engine,
		crg::FramePassGroup &	graph,
		crg::ImageViewIdArray const &	source,
		crg::ImageViewId const &	target,
		crg::FramePass const &	previousPass,
		HdrConfigUbo &	hdrConfigUbo,
		ColourGradingUbo &	colourGradingUbo,
		ProgressBar *	progress )

Specified constructor.

Parameters

[in]	engine	The engine.
[in]	graph	The render graph.
[in]	source	L'image source.
[in]	target	L'image cible.
[in]	previousPass	The previous frame pass.
[in]	hdrConfigUbo	The HDR configuration data.
[in]	colourGradingUbo	The colour grading configuration data.
[in]	progress	The progress bar.

Member Function Documentation

accept()

C3D_API void castor3d::ToneMapping::accept

(

ToneMappingVisitor &

visitor

)

Visitor acceptance function.

Parameters

[in,out]

visitor

The visitor.

getFullName()

C3D_API castor::String const & castor3d::ToneMapping::getFullName

(

)

const

name Getters.

getName()

castor::String const & castor3d::ToneMapping::getName ( ) const

inlinenoexcept

References m_name.

getPass()

crg::FramePass const & castor3d::ToneMapping::getPass ( ) const

inlinenoexcept

References m_pass.

getVertexProgram()

static C3D_API void castor3d::ToneMapping::getVertexProgram ( ast::ShaderBuilder & builder )

static

Retrieves the vertex shader for tone mapping.

Parameters

[in,out]

builder

Receives the shader source.

initialise()

C3D_API void castor3d::ToneMapping::initialise	(	castor::String const &	name,
		crg::ImageViewId const &	source )

Initialises tone mapping shader and pipeline.

Parameters

[in]	name	The tone mapping name.
[in]	source	The initial source image.

update()

C3D_API void castor3d::ToneMapping::update	(	CpuUpdater &	updater,
		crg::ImageViewId const &	source )

Parameters

[in,out]	updater	The update data.
[in]	source	The current source image.

updatePipeline()

C3D_API void castor3d::ToneMapping::updatePipeline

(

castor::String const &

name

)

Initialises tone mapping shader and pipeline.

Parameters

[in]

name

The tone mapping name.

Member Data Documentation

m_colourGradingUbo

ColourGradingUbo& castor3d::ToneMapping::m_colourGradingUbo

protected

m_hdrConfigUbo

HdrConfigUbo& castor3d::ToneMapping::m_hdrConfigUbo

protected

m_name

castor::String castor3d::ToneMapping::m_name { cuT( "linear" ) }

protected

Referenced by getName().

m_pass

crg::FramePass* castor3d::ToneMapping::m_pass {}

protected

Referenced by getPass().

m_passIndex

uint32_t castor3d::ToneMapping::m_passIndex {}

protected

m_program

ashes::PipelineShaderStageCreateInfoArray castor3d::ToneMapping::m_program

protected

m_quad

crg::RenderQuad* castor3d::ToneMapping::m_quad {}

protected

m_shader

castor3d::ProgramModule castor3d::ToneMapping::m_shader { cuT( "ToneMapping" ) }

protected

m_source

crg::ImageViewId castor3d::ToneMapping::m_source

protected

---

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

• Castor3D/Render/ToneMapping/ToneMapping.hpp