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

#include <ParticleSystemImpl.hpp>

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

Graphe de collaboration de castor3d::ParticleSystemImpl:

Types publics
enum class	Type { eCpu = 0 , eComputeShader = 1 , eCount , eMin = eCpu }
	Enumération des types d'implémentation de système de particules. Plus de détails...

Fonctions membres publiques
C3D_API	ParticleSystemImpl (Type type, ParticleSystem &parent)
	Constructeur.
virtual C3D_API	~ParticleSystemImpl () noexcept=default
	Destructeur.
virtual C3D_API bool	initialise (RenderDevice const &device)=0
	Initialise l'implémentation.
virtual C3D_API void	cleanup (RenderDevice const &device)=0
	Nettoie l'implémentation.
virtual C3D_API void	addParticleVariable (castor::String const &name, ParticleFormat type, castor::String const &defaultValue)=0
	Ajoute une variable de particule.
virtual C3D_API void	update (CpuUpdater &updater)=0
	Met à jour la passe de rendu, au niveau CPU.
virtual C3D_API uint32_t	update (GpuUpdater &updater)=0
	Met à jour la passe de rendu, au niveau GPU.
Type	getType ()
ParticleSystem const &	getParent () const

Attributs protégés
ParticleSystem &	m_parent
Type	m_type

Documentation des énumérations membres

Type

enum class castor3d::ParticleSystemImpl::Type

strong

Enumération des types d'implémentation de système de particules.

Valeurs énumérées
eCpu	Les particules sont mises à jour sur le CPU.
eComputeShader	Les particules sont mises à jour en utilisant un compute shader.
eCount
eMin

Documentation des constructeurs et destructeur

ParticleSystemImpl()

C3D_API castor3d::ParticleSystemImpl::ParticleSystemImpl	(	Type	type,
		ParticleSystem &	parent )

Constructeur.

Paramètres

[in]	type	Le type d'implémentation.
[in]	parent	Le système de particules parent.

~ParticleSystemImpl()

virtual C3D_API castor3d::ParticleSystemImpl::~ParticleSystemImpl ( )

virtualdefaultnoexcept

Destructeur.

Documentation des fonctions membres

addParticleVariable()

virtual C3D_API void castor3d::ParticleSystemImpl::addParticleVariable ( castor::String const & name, ParticleFormat type, castor::String const & defaultValue )

pure virtual

Ajoute une variable de particule.

Paramètres

[in]	name	Le nom de la variable.
[in]	type	Le type de la variable.
[in]	defaultValue	La valeur par défaut de la variable.

Implémenté dans castor3d::ComputeParticleSystem, et castor3d::CpuParticleSystem.

cleanup()

virtual C3D_API void castor3d::ParticleSystemImpl::cleanup ( RenderDevice const & device )

pure virtual

Nettoie l'implémentation.

Paramètres

device

Le device actuel.

Implémenté dans castor3d::ComputeParticleSystem, et castor3d::CpuParticleSystem.

getParent()

ParticleSystem const & castor3d::ParticleSystemImpl::getParent ( ) const

inline

Renvoie

Le système de particules parent.

Références m_parent.

getType()

Type castor3d::ParticleSystemImpl::getType ( )

inline

Renvoie

Le type d'implémentation.

Références m_type.

initialise()

virtual C3D_API bool castor3d::ParticleSystemImpl::initialise ( RenderDevice const & device )

pure virtual

Initialise l'implémentation.

Paramètres

device

Le device actuel.

Renvoie

true si tout s'est bien passé.

Implémenté dans castor3d::ComputeParticleSystem, et castor3d::CpuParticleSystem.

update() [1/2]

virtual C3D_API void castor3d::ParticleSystemImpl::update ( CpuUpdater & updater )

pure virtual

Met à jour la passe de rendu, au niveau CPU.

Paramètres

[in,out]

updater

Les données d'update.

Implémenté dans castor3d::CpuParticleSystem, et castor3d::ComputeParticleSystem.

update() [2/2]

virtual C3D_API uint32_t castor3d::ParticleSystemImpl::update ( GpuUpdater & updater )

pure virtual

Met à jour la passe de rendu, au niveau GPU.

Paramètres

[in,out]

updater

Les données d'update.

Implémenté dans castor3d::CpuParticleSystem, et castor3d::ComputeParticleSystem.

Documentation des données membres

m_parent

ParticleSystem& castor3d::ParticleSystemImpl::m_parent

protected

Le système de particules parent.

Référencé par getParent().

m_type

Type castor3d::ParticleSystemImpl::m_type

protected

Le type d'implémentation.

Référencé par getType().

---

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

• Castor3D/Scene/ParticleSystem/ParticleSystemImpl.hpp