Castor3D::ToneMapping Class Reference

Tone mapping base class. More...

Inheritance diagram for Castor3D::ToneMapping:

Collaboration diagram for Castor3D::ToneMapping:

Public Member Functions
C3D_API	ToneMapping (eTONE_MAPPING_TYPE p_type, Engine &p_engine, Parameters const &p_parameters)
	Specified constructor. More...
virtual C3D_API	~ToneMapping ()
	Destructor. More...
C3D_API bool	Initialise ()
	Initialises tone mapping shader. More...
C3D_API void	Cleanup ()
	Cleanup function. More...
C3D_API void	Apply (Castor::Size const &p_size, Texture const &p_texture)
	Applies the tone mapping for given HDR texture. More...

Protected Member Functions
virtual C3D_API Castor::String	DoCreate ()=0
	Creates tone mapping shader, and the shader variables. More...
virtual C3D_API void	DoDestroy ()=0
	Cleans up the tone mapping shader variables. More...
virtual C3D_API void	DoUpdate ()=0
	Updates the tone mapping shader variables. More...

Protected Attributes
eTONE_MAPPING_TYPE	m_type
	The tone mapping type. More...
ShaderProgramSPtr	m_program
	The Reinhard tone mapping shader program. More...
float	m_exposure
	The exposure value. More...
OneFloatFrameVariableSPtr	m_exposureVar
	The exposure shader variable. More...

Static Protected Attributes
static Castor::String const	HdrConfig
	The configuration constants buffer name. More...
static Castor::String const	Exposure
	The exposure constant name. More...

Detailed Description

Tone mapping base class.

Author

Sylvain DOREMUS

Version

0.8.0

Date

11/03/2016

Constructor & Destructor Documentation

ToneMapping()

C3D_API Castor3D::ToneMapping::ToneMapping	(	eTONE_MAPPING_TYPE	p_type,
		Engine &	p_engine,
		Parameters const &	p_parameters
	)

Specified constructor.

Parameters

[in]	p_type	The tone mapping type.
[in]	p_engine	The engine.
[in]	p_parameters	The implementation specific parameters.

~ToneMapping()

virtual C3D_API Castor3D::ToneMapping::~ToneMapping ( )

virtual

Destructor.

Member Function Documentation

Apply()

C3D_API void Castor3D::ToneMapping::Apply	(	Castor::Size const &	p_size,
		Texture const &	p_texture
	)

Applies the tone mapping for given HDR texture.

Parameters

[in]	p_size	The target dimensions.
[in]	p_texture	The HDR texture.

Applique le mappage de tons pour la texture HDR donnée.

Parameters

[in]	p_size	Les dimensions de la cible.
[in]	p_texture	La texture HDR.

Cleanup()

C3D_API void Castor3D::ToneMapping::Cleanup

(

)

Cleanup function.

DoCreate()

virtual C3D_API Castor::String Castor3D::ToneMapping::DoCreate ( )

protectedpure virtual

Creates tone mapping shader, and the shader variables.

Returns

The pixel shader program.

DoDestroy()

virtual C3D_API void Castor3D::ToneMapping::DoDestroy ( )

protectedpure virtual

Cleans up the tone mapping shader variables.

DoUpdate()

virtual C3D_API void Castor3D::ToneMapping::DoUpdate ( )

protectedpure virtual

Updates the tone mapping shader variables.

Met à jour les variables shader du mappage de tons.

Initialise()

C3D_API bool Castor3D::ToneMapping::Initialise

(

)

Initialises tone mapping shader.

Member Data Documentation

Exposure

Castor::String const Castor3D::ToneMapping::Exposure

staticprotected

The exposure constant name.

HdrConfig

Castor::String const Castor3D::ToneMapping::HdrConfig

staticprotected

The configuration constants buffer name.

m_exposure

float Castor3D::ToneMapping::m_exposure

protected

The exposure value.

m_exposureVar

OneFloatFrameVariableSPtr Castor3D::ToneMapping::m_exposureVar

protected

The exposure shader variable.

m_program

ShaderProgramSPtr Castor3D::ToneMapping::m_program

protected

The Reinhard tone mapping shader program.

m_type

eTONE_MAPPING_TYPE Castor3D::ToneMapping::m_type

protected

The tone mapping type.

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/ToneMapping.hpp