Référence de la classe castor3d::PostEffect

#include <PostEffect.hpp>

Graphe d'héritage de castor3d::PostEffect:

Graphe de collaboration de castor3d::PostEffect:

Types publics
enum class	Kind { eHDR , eSRGB , eOverlay }

Fonctions membres publiques
virtual C3D_API	~PostEffect () noexcept=default
	Destructeur.
C3D_API bool	writeInto (castor::StringStream &file, castor::String const &tabs)
	Ecrit l'effet dans un fichier texte.
C3D_API bool	initialise (castor3d::RenderDevice const &device, Texture const &source, Texture const &target, crg::FramePass const &previousPass)
	Fonction d'initialisation.
C3D_API void	cleanup (castor3d::RenderDevice const &device)
	Fonction de nettoyage.
C3D_API bool	update (CpuUpdater &updater, Texture const &source)
C3D_API void	update (GpuUpdater &updater)
virtual C3D_API void	accept (ConfigurationVisitorBase &visitor)=0
	Fonction d'acceptation de visiteur.
void	enable (bool value) noexcept
virtual C3D_API crg::FramePass const &	getPass () const =0
virtual C3D_API void	setParameters (Parameters parameters)=0
bool	isAfterToneMapping () const noexcept
castor::String const &	getFullName () const noexcept
bool const &	isEnabled () const noexcept
Fonctions membres publiques hérités de castor::OwnedBy< RenderSystem >
RenderSystem *	getOwner () const
	L'objet propriétaire.
Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.
T const &	getName () const noexcept
	Récupère le nom.
void	rename (T name) noexcept

Fonctions membres protégées
C3D_API	PostEffect (castor::String const &name, castor::String const &groupName, castor::String const &fullName, RenderTarget &renderTarget, RenderSystem &renderSystem, Parameters const &parameters, uint32_t passesCount=1u, Kind kind=Kind::eHDR)
	Constructeur.
Fonctions membres protégées hérités de castor::OwnedBy< RenderSystem >
	OwnedBy (RenderSystem &owner)
	Constructeur.

Attributs protégés
castor::String	m_fullName
RenderTarget &	m_renderTarget
crg::FramePassGroup &	m_graph
uint32_t	m_passesCount { 1u }
Kind	m_kind { Kind::eHDR }
bool	m_enabled { true }
uint32_t	m_passIndex {}
Texture const *	m_source {}
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Documentation des énumérations membres

Kind

enum class castor3d::PostEffect::Kind

strong

Valeurs énumérées
eHDR
eSRGB
eOverlay

Documentation des constructeurs et destructeur

PostEffect()

C3D_API castor3d::PostEffect::PostEffect ( castor::String const & name, castor::String const & groupName, castor::String const & fullName, RenderTarget & renderTarget, RenderSystem & renderSystem, Parameters const & parameters, uint32_t passesCount = 1u, Kind kind = Kind::eHDR )

protected

Constructeur.

Paramètres

[in]	name	Le nom de l'effet.
[in]	groupName	Le nom du groupe de passes de l'effet.
[in]	fullName	Le nom complet (et joli) de l'effet.
[in]	renderTarget	La cible de rendu sur laquelle cet effet s'applique.
[in]	renderSystem	Le render system.
[in]	parameters	Les paramètres optionnels.
[in]	passesCount	Le nombre de passes pour cet effet.
[in]	kind	Le type d'effet.

~PostEffect()

virtual C3D_API castor3d::PostEffect::~PostEffect ( )

virtualdefaultnoexcept

Destructeur.

Documentation des fonctions membres

accept()

virtual C3D_API void castor3d::PostEffect::accept ( ConfigurationVisitorBase & visitor )

pure virtual

Fonction d'acceptation de visiteur.

Paramètres

visitor

Le ... visiteur.

cleanup()

C3D_API void castor3d::PostEffect::cleanup

(

castor3d::RenderDevice const &

device

)

Fonction de nettoyage.

Paramètres

[in]

device

Le device GPU.

enable()

void castor3d::PostEffect::enable ( bool value )

inlinenoexcept

name Mutateurs.

Références m_enabled.

getFullName()

castor::String const & castor3d::PostEffect::getFullName ( ) const

inlinenoexcept

Références m_fullName.

getPass()

virtual C3D_API crg::FramePass const & castor3d::PostEffect::getPass ( ) const

pure virtual

name Accesseurs.

initialise()

C3D_API bool castor3d::PostEffect::initialise	(	castor3d::RenderDevice const &	device,
		Texture const &	source,
		Texture const &	target,
		crg::FramePass const &	previousPass )

Fonction d'initialisation.

Paramètres

[in]	device	Le device GPU.
[in]	source	La texture source.
[in]	target	La texture cible.
[in]	previousPass	La frame pass précédente.

Renvoie

true if ok.

isAfterToneMapping()

bool castor3d::PostEffect::isAfterToneMapping ( ) const

inlinenoexcept

Références eSRGB, et m_kind.

isEnabled()

bool const & castor3d::PostEffect::isEnabled ( ) const

inlinenoexcept

Références m_enabled.

setParameters()

virtual C3D_API void castor3d::PostEffect::setParameters ( Parameters parameters )

pure virtual

update() [1/2]

C3D_API bool castor3d::PostEffect::update	(	CpuUpdater &	updater,
		Texture const &	source )

Paramètres

[in,out]	updater	Les données d'update.
[in]	source	L'image source courante.

update() [2/2]

C3D_API void castor3d::PostEffect::update

(

GpuUpdater &

updater

)

Paramètres

[in,out]

updater

Les données d'update.

writeInto()

C3D_API bool castor3d::PostEffect::writeInto	(	castor::StringStream &	file,
		castor::String const &	tabs )

Ecrit l'effet dans un fichier texte.

Paramètres

[in]	file	Le fichier.
[in]	tabs	L'indentation actuelle.

Documentation des données membres

m_enabled

bool castor3d::PostEffect::m_enabled { true }

protected

Référencé par enable(), et isEnabled().

m_fullName

castor::String castor3d::PostEffect::m_fullName

protected

Référencé par getFullName().

m_graph

crg::FramePassGroup& castor3d::PostEffect::m_graph

protected

m_kind

Kind castor3d::PostEffect::m_kind { Kind::eHDR }

protected

Référencé par isAfterToneMapping().

m_passesCount

uint32_t castor3d::PostEffect::m_passesCount { 1u }

protected

m_passIndex

uint32_t castor3d::PostEffect::m_passIndex {}

protected

m_renderTarget

RenderTarget& castor3d::PostEffect::m_renderTarget

protected

m_source

Texture const* castor3d::PostEffect::m_source {}

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Castor3D/Render/PostEffect/PostEffect.hpp