#include <ComputeParticleSystem.hpp>

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

Graphe de collaboration de castor3d::ComputeParticleSystem:

[légende]

Classes
struct	Configuration

Fonctions membres publiques
C3D_API	ComputeParticleSystem (ParticleSystem &parent)
	Constructeur.

C3D_API bool	initialise (RenderDevice const &device) override
	Initialise l'implémentation.

C3D_API void	cleanup (RenderDevice const &device) override
	Nettoie l'implémentation.

C3D_API void	update (CpuUpdater &updater) override
	Met à jour la passe de rendu, au niveau CPU.

C3D_API uint32_t	update (GpuUpdater &updater) override
	Met à jour la passe de rendu, au niveau CPU.

C3D_API void	addParticleVariable (castor::String const &name, ParticleFormat type, castor::String const &defaultValue) override
	Ajoute une variable de particule.

C3D_API void	setUpdateProgram (ShaderProgramRPtr program)
	Définit le programme utilisé pour mettre à jour les particules.

void	setGroupSizes (castor::Point3i sizes)
	Définit les dimensions des groupes de travail, tels que définis dans le compute shader.

bool	hasUpdateProgram () const

ShaderProgram const &	getUpdateProgram () const

Fonctions membres publiques hérités de castor3d::ParticleSystemImpl
C3D_API	ParticleSystemImpl (Type type, ParticleSystem &parent)
	Constructeur.

virtual C3D_API	~ParticleSystemImpl () noexcept=default
	Destructeur.

Type	getType ()

ParticleSystem const &	getParent () const

Attributs protégés
ParticleDeclaration	m_inputs

ShaderProgramRPtr	m_program {}

UniformBufferOffsetT< Configuration >	m_ubo

castor::Array< ashes::BufferPtr< uint8_t >, 2 >	m_particlesStorages

ashes::BufferPtr< uint32_t >	m_generatedCountBuffer

ashes::DescriptorSetLayoutPtr	m_descriptorLayout

ashes::PipelineLayoutPtr	m_pipelineLayout

ashes::ComputePipelinePtr	m_pipeline

ashes::DescriptorSetPoolPtr	m_descriptorPool

castor::Array< ashes::DescriptorSetPtr, 2u >	m_descriptorSets

ashes::CommandBufferPtr	m_commandBuffer

ashes::FencePtr	m_fence

uint32_t	m_particlesCount { 0u }

castor::Point3i	m_worgGroupSizes { 128, 1, 1 }

uint32_t	m_in { 0 }

uint32_t	m_out { 1 }

Attributs protégés hérités de castor3d::ParticleSystemImpl
ParticleSystem &	m_parent

Type	m_type

Membres hérités additionnels
Types publics hérités de castor3d::ParticleSystemImpl
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...

Documentation des constructeurs et destructeur

◆ ComputeParticleSystem()

C3D_API castor3d::ComputeParticleSystem::ComputeParticleSystem ( ParticleSystem & parent )

explicit

Constructeur.

Paramètres

[in] parent Le système de particules parent.

Documentation des fonctions membres

◆ addParticleVariable()

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

overridevirtual

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émente castor3d::ParticleSystemImpl.

◆ cleanup()

C3D_API void castor3d::ComputeParticleSystem::cleanup ( RenderDevice const & device )

overridevirtual

Nettoie l'implémentation.

Paramètres

device Le device actuel.

Implémente castor3d::ParticleSystemImpl.

◆ getUpdateProgram()

ShaderProgram const & castor3d::ComputeParticleSystem::getUpdateProgram ( ) const

inline

Renvoie: Le programme de mise à jour.

Références m_program.

◆ hasUpdateProgram()

bool castor3d::ComputeParticleSystem::hasUpdateProgram ( ) const

inline

Renvoie: false si le programme de mise à jour n'a pas été défini.

Références m_program.

◆ initialise()

C3D_API bool castor3d::ComputeParticleSystem::initialise ( RenderDevice const & device )

overridevirtual

Initialise l'implémentation.

Paramètres

device Le device actuel.

Renvoie: true si tout s'est bien passé.

Implémente castor3d::ParticleSystemImpl.

◆ setGroupSizes()

void castor3d::ComputeParticleSystem::setGroupSizes ( castor::Point3i sizes )

inline

Définit les dimensions des groupes de travail, tels que définis dans le compute shader.

Paramètres

[in] sizes Les dimensions.

Références m_worgGroupSizes.

◆ setUpdateProgram()

C3D_API void castor3d::ComputeParticleSystem::setUpdateProgram ( ShaderProgramRPtr program )

Définit le programme utilisé pour mettre à jour les particules.

Paramètres

[in] program Le programme shader.

◆ update() [1/2]

C3D_API void castor3d::ComputeParticleSystem::update ( CpuUpdater & updater )

overridevirtual

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

Paramètres

[in,out] updater Les données d'update.

Implémente castor3d::ParticleSystemImpl.

◆ update() [2/2]

C3D_API uint32_t castor3d::ComputeParticleSystem::update ( GpuUpdater & updater )

overridevirtual

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

Paramètres

[in,out] updater Les données d'update.

Implémente castor3d::ParticleSystemImpl.

Documentation des données membres

◆ m_commandBuffer

ashes::CommandBufferPtr castor3d::ComputeParticleSystem::m_commandBuffer

protected

◆ m_descriptorLayout

ashes::DescriptorSetLayoutPtr castor3d::ComputeParticleSystem::m_descriptorLayout

protected

◆ m_descriptorPool

ashes::DescriptorSetPoolPtr castor3d::ComputeParticleSystem::m_descriptorPool

protected

◆ m_descriptorSets

castor::Array< ashes::DescriptorSetPtr, 2u > castor3d::ComputeParticleSystem::m_descriptorSets

protected

◆ m_fence

ashes::FencePtr castor3d::ComputeParticleSystem::m_fence

protected

◆ m_generatedCountBuffer

ashes::BufferPtr< uint32_t > castor3d::ComputeParticleSystem::m_generatedCountBuffer

protected

◆ m_in

uint32_t castor3d::ComputeParticleSystem::m_in { 0 }

protected

◆ m_inputs

ParticleDeclaration castor3d::ComputeParticleSystem::m_inputs

protected

◆ m_out

uint32_t castor3d::ComputeParticleSystem::m_out { 1 }

protected

◆ m_particlesCount

uint32_t castor3d::ComputeParticleSystem::m_particlesCount { 0u }

protected

◆ m_particlesStorages

castor::Array< ashes::BufferPtr< uint8_t >, 2 > castor3d::ComputeParticleSystem::m_particlesStorages

protected

◆ m_pipeline

ashes::ComputePipelinePtr castor3d::ComputeParticleSystem::m_pipeline

protected

◆ m_pipelineLayout

ashes::PipelineLayoutPtr castor3d::ComputeParticleSystem::m_pipelineLayout

protected

◆ m_program

ShaderProgramRPtr castor3d::ComputeParticleSystem::m_program {}

protected

Référencé par getUpdateProgram(), et hasUpdateProgram().

◆ m_ubo

UniformBufferOffsetT< Configuration > castor3d::ComputeParticleSystem::m_ubo

protected

◆ m_worgGroupSizes

castor::Point3i castor3d::ComputeParticleSystem::m_worgGroupSizes { 128, 1, 1 }

protected

Référencé par setGroupSizes().

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

Castor3D/Scene/ParticleSystem/ComputeParticleSystem.hpp

Classes

Fonctions membres publiques

Attributs protégés

Membres hérités additionnels

Documentation des constructeurs et destructeur

◆ ComputeParticleSystem()

Documentation des fonctions membres

◆ addParticleVariable()

◆ cleanup()

◆ getUpdateProgram()

◆ hasUpdateProgram()

◆ initialise()

◆ setGroupSizes()

◆ setUpdateProgram()

◆ update() [1/2]

◆ update() [2/2]

Documentation des données membres

◆ m_commandBuffer

◆ m_descriptorLayout

◆ m_descriptorPool

◆ m_descriptorSets

◆ m_fence

◆ m_generatedCountBuffer

◆ m_in

◆ m_inputs

◆ m_out

◆ m_particlesCount

◆ m_particlesStorages

◆ m_pipeline

◆ m_pipelineLayout

◆ m_program

◆ m_ubo

◆ m_worgGroupSizes