Interface de tampon de stockage shader. Plus de détails...

Graphe d'héritage de Castor3D::ShaderStorageBuffer:

Graphe de collaboration de Castor3D::ShaderStorageBuffer:

Fonctions membres publiques
C3D_API	ShaderStorageBuffer (Castor::String const &p_name, ShaderProgram &p_program)
	Constructeur. Plus de détails...

virtual C3D_API	~ShaderStorageBuffer ()
	Destructeur. Plus de détails...

C3D_API bool	Initialise (uint32_t p_size, uint32_t p_index, BufferAccessType p_type, BufferAccessNature p_nature)
	Initialise le tampon GPU. Plus de détails...

C3D_API void	Cleanup ()
	Nettoie toutes les variables et le tampon GPU associé. Plus de détails...

C3D_API uint8_t *	Lock (uint32_t p_offset, uint32_t p_count, AccessTypes const &p_flags)
	Locke le tampon, càd le mappe en mémoire ram afin d'y autoriser des modifications. Plus de détails...

C3D_API void	Unlock ()
	Un locke le tampon, càd l'unmappe de la mémoire ram afin de ne plus autoriser de modifications dessus. Plus de détails...

C3D_API void	Upload (uint32_t p_offset, uint32_t p_count, uint8_t const *p_buffer)
	Transfère des données au tampon GPU à partir de la RAM. Plus de détails...

C3D_API void	Download (uint32_t p_offset, uint32_t p_count, uint8_t *p_buffer)
	Transfère des données du tampon GPU vers la RAM. Plus de détails...

C3D_API void	Bind ()
	Fonction d'activation, pour dire au GPU qu'il est activé. Plus de détails...

C3D_API void	BindTo (uint32_t p_point)
	Active le tampon au point d'attache donné. Plus de détails...

C3D_API void	Unbind ()
	Fonction de désactivation, pour dire au GPU qu'il est désactivé. Plus de détails...

C3D_API void	Copy (GpuBuffer< uint8_t > const &p_src, uint32_t p_size)
	Copie les données du tampon donné dans celui-ci. Plus de détails...

GpuBuffer< uint8_t > const &	GetGpuBuffer () const

Attributs protégés
GpuBufferUPtr	m_gpuBuffer

Description détaillée

Interface de tampon de stockage shader.

Auteur: Sylvain DOREMUS

Version: 0.9.0

Date: 22/11/2016

Documentation des constructeurs et destructeur

◆ ShaderStorageBuffer()

C3D_API Castor3D::ShaderStorageBuffer::ShaderStorageBuffer	(	Castor::String const &	p_name,
		ShaderProgram &	p_program
	)

Constructeur.

Paramètres

[in]	p_name	Le nom du tampon.
[in]	p_program	Le programme parent.

◆ ~ShaderStorageBuffer()

virtual C3D_API Castor3D::ShaderStorageBuffer::~ShaderStorageBuffer ( )

virtual

Destructeur.

Documentation des fonctions membres

◆ Bind()

C3D_API void Castor3D::ShaderStorageBuffer::Bind ( )

Fonction d'activation, pour dire au GPU qu'il est activé.

◆ BindTo()

C3D_API void Castor3D::ShaderStorageBuffer::BindTo ( uint32_t p_point )

Active le tampon au point d'attache donné.

Paramètres

[in] p_point Le point d'attache.

◆ Cleanup()

C3D_API void Castor3D::ShaderStorageBuffer::Cleanup ( )

Nettoie toutes les variables et le tampon GPU associé.

◆ Copy()

C3D_API void Castor3D::ShaderStorageBuffer::Copy	(	GpuBuffer< uint8_t > const &	p_src,
		uint32_t	p_size
	)

Copie les données du tampon donné dans celui-ci.

Paramètres

[in]	p_src	Le tampon source.
[in]	p_size	Le nombre d'éléments à copier.

◆ Download()

C3D_API void Castor3D::ShaderStorageBuffer::Download	(	uint32_t	p_offset,
		uint32_t	p_count,
		uint8_t *	p_buffer
	)

Transfère des données du tampon GPU vers la RAM.

Remarques: Transfère les données de tampon[p_offset*sizeof( T )] à tampon[(p_offset+p_count-1) * sizeof( T )].

Paramètres

[in]	p_offset	L'offset de départ.
[in]	p_count	Nombre d'éléments.
[out]	p_buffer	Les données.

◆ GetGpuBuffer()

GpuBuffer< uint8_t > const& Castor3D::ShaderStorageBuffer::GetGpuBuffer ( ) const

inline

Renvoie: Le tampon GPU.

Références m_gpuBuffer.

◆ Initialise()

C3D_API bool Castor3D::ShaderStorageBuffer::Initialise	(	uint32_t	p_size,
		uint32_t	p_index,
		BufferAccessType	p_type,
		BufferAccessNature	p_nature
	)

Initialise le tampon GPU.

Paramètres

[in]	p_size	Taille du tampon.
[in]	p_index	L'index d'attache.
[in]	p_type	Type d'accès du tampon.
[in]	p_nature	Nature d'accès du tampon.

Renvoie: false if any problem occured.

◆ Lock()

C3D_API uint8_t* Castor3D::ShaderStorageBuffer::Lock	(	uint32_t	p_offset,
		uint32_t	p_count,
		AccessTypes const &	p_flags
	)

Locke le tampon, càd le mappe en mémoire ram afin d'y autoriser des modifications.

Remarques: Mappe de tampon[p_offset*sizeof( T )] à tampon[(p_offset+p_uiSize-1) * sizeof( T )].

Paramètres

[in]	p_offset	L'offset de départ.
[in]	p_count	Le nombre d'éléments à mapper.
[in]	p_flags	Les flags de lock.

Renvoie: L'adresse du tampon mappé.

◆ Unbind()

C3D_API void Castor3D::ShaderStorageBuffer::Unbind ( )

Fonction de désactivation, pour dire au GPU qu'il est désactivé.

◆ Unlock()

C3D_API void Castor3D::ShaderStorageBuffer::Unlock ( )

Un locke le tampon, càd l'unmappe de la mémoire ram afin de ne plus autoriser de modifications dessus.

Remarques: Toutes les modifications qui avaient été effectuées sur le tampon mappé sont rapatriées dans la mémoire GPU.

◆ Upload()

C3D_API void Castor3D::ShaderStorageBuffer::Upload	(	uint32_t	p_offset,
		uint32_t	p_count,
		uint8_t const *	p_buffer
	)

Transfère des données au tampon GPU à partir de la RAM.

Remarques: Transfère les données de tampon[p_offset*sizeof( T )] à tampon[(p_offset+p_count-1) * sizeof( T )].

Paramètres

[in]	p_offset	L'offset de départ.
[in]	p_count	Nombre d'éléments.
[in]	p_buffer	Les données.

Documentation des données membres

◆ m_gpuBuffer

GpuBufferUPtr Castor3D::ShaderStorageBuffer::m_gpuBuffer

protected

Le tampon GPU.

Référencé par GetGpuBuffer().

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Shader/ShaderStorageBuffer.hpp

Fonctions membres publiques

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

◆ ShaderStorageBuffer()

◆ ~ShaderStorageBuffer()

Documentation des fonctions membres

◆ Bind()

◆ BindTo()

◆ Cleanup()

◆ Copy()

◆ Download()

◆ GetGpuBuffer()

◆ Initialise()

◆ Lock()

◆ Unbind()

◆ Unlock()

◆ Upload()

Documentation des données membres

◆ m_gpuBuffer