Un tampon typé d'uniformes, puovant contenir de multiples sous-tampons. Plus de détails...

#include <UniformBuffer.hpp>

Graphe d'héritage de castor3d::UniformBufferT< DataT >:

Graphe de collaboration de castor3d::UniformBufferT< DataT >:

Fonctions membres publiques
	UniformBufferT (RenderSystem const &renderSystem, VkDeviceSize count, VkBufferUsageFlags usage, VkMemoryPropertyFlags flags, castor::String debugName, ashes::QueueShare sharingMode={})
	Constructeur.

void	upload (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, uint32_t offset, VkPipelineStageFlags flags) const
	Transfère des données au tampon GPU à partir de la RAM.

void	upload (ashes::BufferBase const &stagingBuffer, ashes::CommandBuffer const &commandBuffer, uint32_t offset, VkPipelineStageFlags flags) const
	Transfère des données au tampon GPU à partir de la RAM.

void	upload (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer const &timer, uint32_t index) const
	Transfère des données au tampon GPU à partir de la RAM.

void	upload (ashes::BufferBase const &stagingBuffer, ashes::CommandBuffer const &commandBuffer, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer const &timer, uint32_t index) const
	Transfère des données au tampon GPU à partir de la RAM.

void	upload (VkDeviceSize offset=0u, VkDeviceSize range=1u) const
	Met en VRAM les données du tampon.

void	download (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer const &timer, uint32_t index)
	Transfère des données du tampon GPU vers la RAM.

DataT const &	getData (VkDeviceSize index=0) const

DataT &	getData (VkDeviceSize index=0)

castor::Vector< DataT > const &	getDatas () const

castor::Vector< DataT > &	getDatas ()

Fonctions membres publiques hérités de castor3d::UniformBufferBase
C3D_API	UniformBufferBase (RenderSystem const &renderSystem, VkDeviceSize elemCount, VkDeviceSize elemSize, VkBufferUsageFlags usage, VkMemoryPropertyFlags flags, castor::String debugName, ashes::QueueShare sharingMode={})
	Constructeur.

virtual C3D_API	~UniformBufferBase () noexcept=default
	Destructeur.

C3D_API uint32_t	initialise (RenderDevice const &device)
	Initialise le tampon GPU.

C3D_API uint32_t	initialise (RenderDevice const &device, ashes::QueueShare sharingMode)
	Initialise le tampon GPU.

C3D_API void	cleanup () noexcept
	Nettoie le tampon GPU.

C3D_API bool	hasAvailable () const noexcept

C3D_API uint32_t	allocate () noexcept
	Alloue une zone mémoire pour un CPU buffer.

C3D_API void	deallocate (uint32_t offset)
	Désalloue de la mémoire.

C3D_API void	upload (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, const void *data, size_t size, uint32_t offset, VkPipelineStageFlags flags) const
	Transfère des données au tampon GPU à partir de la RAM.

void	upload (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, ashes::ByteArray const &data, uint32_t offset, VkPipelineStageFlags flags) const
	Transfère des données au tampon GPU à partir de la RAM.

C3D_API void	upload (ashes::BufferBase const &stagingBuffer, ashes::CommandBuffer const &commandBuffer, const void *data, size_t size, uint32_t offset, VkPipelineStageFlags flags) const
	Transfère des données au tampon GPU à partir de la RAM.

void	upload (ashes::BufferBase const &stagingBuffer, ashes::CommandBuffer const &commandBuffer, ashes::ByteArray const &data, uint32_t offset, VkPipelineStageFlags flags) const
	Transfère des données au tampon GPU à partir de la RAM.

C3D_API void	upload (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, const void *data, size_t size, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer &timer) const
	Transfère des données au tampon GPU à partir de la RAM.

void	upload (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, ashes::ByteArray const &data, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer &timer) const
	Transfère des données au tampon GPU à partir de la RAM.

C3D_API void	upload (ashes::BufferBase const &stagingBuffer, ashes::CommandBuffer const &commandBuffer, const void *data, size_t size, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer &timer) const
	Transfère des données au tampon GPU à partir de la RAM.

void	upload (ashes::BufferBase const &stagingBuffer, ashes::CommandBuffer const &commandBuffer, ashes::ByteArray const &data, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer &timer) const
	Transfère des données au tampon GPU à partir de la RAM.

C3D_API void	download (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, void *data, size_t size, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer &timer) const
	Transfère des données du tampon GPU vers la RAM.

void	download (ashes::BufferBase const &stagingBuffer, ashes::Queue const &queue, ashes::CommandPool const &commandPool, ashes::ByteArray &data, uint32_t offset, VkPipelineStageFlags flags, FramePassTimer &timer) const
	Transfère des données du tampon GPU vers la RAM.

bool	hasBuffer () const

ashes::UniformBuffer const &	getBuffer () const

ashes::UniformBuffer &	getBuffer ()

uint32_t	getElementSize () const

uint32_t	getAlignedSize (uint32_t size) const
	Récupère la taille alignée d'un élément.

uint32_t	getAlignedSize () const

Description détaillée

template<typename DataT>
class castor3d::UniformBufferT< DataT >

Un tampon typé d'uniformes, puovant contenir de multiples sous-tampons.

Remarques

Documentation des constructeurs et destructeur

◆ UniformBufferT()

template<typename DataT >

castor3d::UniformBufferT< DataT >::UniformBufferT	(	RenderSystem const &	renderSystem,
		VkDeviceSize	count,
		VkBufferUsageFlags	usage,
		VkMemoryPropertyFlags	flags,
		castor::String	debugName,
		ashes::QueueShare	sharingMode = {} )

Constructeur.

Paramètres

[in]	renderSystem	Le RenderSystem.
[in]	count	Le nombre d'éléments.
[in]	usage	Les indicateurs d'utilisation du tampon.
[in]	flags	Les indicateurs de mémoire du tampon.
[in]	debugName	Le nom debug du tampon.
[in]	sharingMode	Le mode de partage du tampon.

Documentation des fonctions membres

◆ download()

template<typename DataT >

void castor3d::UniformBufferT< DataT >::download	(	ashes::BufferBase const &	stagingBuffer,
		ashes::Queue const &	queue,
		ashes::CommandPool const &	commandPool,
		uint32_t	offset,
		VkPipelineStageFlags	flags,
		FramePassTimer const &	timer,
		uint32_t	index )

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

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

Paramètres

[in]	stagingBuffer	Le staging buffer utilisé pour effectuer le transfer.
[in]	queue	La file sur laquelle le transfert sera effectué.
[in]	commandPool	Le command pool depuis lequel le command buffer sera créé.
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.
[in]	timer	Le timer de passe de rendu.
[in]	index	L'indice de passe de rendu.

◆ getData() [1/2]

template<typename DataT >

DataT & castor3d::UniformBufferT< DataT >::getData ( VkDeviceSize index = 0 )

inline

Renvoie: La n-ème instance des données.

Paramètres

[in] index L'indice de l'instance.

◆ getData() [2/2]

template<typename DataT >

DataT const & castor3d::UniformBufferT< DataT >::getData ( VkDeviceSize index = 0 ) const

inline

Renvoie: La n-ème instance des données.

Paramètres

[in] index L'indice de l'instance.

◆ getDatas() [1/2]

template<typename DataT >

castor::Vector< DataT > & castor3d::UniformBufferT< DataT >::getDatas ( )

inline

Renvoie: Les données.

◆ getDatas() [2/2]

template<typename DataT >

castor::Vector< DataT > const & castor3d::UniformBufferT< DataT >::getDatas ( ) const

inline

Renvoie: Les données.

◆ upload() [1/5]

template<typename DataT >

void castor3d::UniformBufferT< DataT >::upload	(	ashes::BufferBase const &	stagingBuffer,
		ashes::CommandBuffer const &	commandBuffer,
		uint32_t	offset,
		VkPipelineStageFlags	flags ) const

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

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

Paramètres

[in]	stagingBuffer	Le staging buffer utilisé pour effectuer le transfer.
[in]	commandBuffer	Le command buffer sur lequel les commandes de transfert sont enregistrées.
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.

◆ upload() [2/5]

template<typename DataT >

void castor3d::UniformBufferT< DataT >::upload	(	ashes::BufferBase const &	stagingBuffer,
		ashes::CommandBuffer const &	commandBuffer,
		uint32_t	offset,
		VkPipelineStageFlags	flags,
		FramePassTimer const &	timer,
		uint32_t	index ) const

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

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

Paramètres

[in]	stagingBuffer	Le staging buffer utilisé pour effectuer le transfer.
[in]	commandBuffer	Le command buffer sur lequel les commandes de transfert sont enregistrées.
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.
[in]	timer	Le timer de passe de rendu.
[in]	index	L'indice de passe de rendu.

◆ upload() [3/5]

template<typename DataT >

void castor3d::UniformBufferT< DataT >::upload	(	ashes::BufferBase const &	stagingBuffer,
		ashes::Queue const &	queue,
		ashes::CommandPool const &	commandPool,
		uint32_t	offset,
		VkPipelineStageFlags	flags ) const

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

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

Paramètres

[in]	stagingBuffer	Le staging buffer utilisé pour effectuer le transfer.
[in]	queue	La file sur laquelle le transfert sera effectué.
[in]	commandPool	Le command pool depuis lequel le command buffer sera créé.
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.

◆ upload() [4/5]

template<typename DataT >

void castor3d::UniformBufferT< DataT >::upload	(	ashes::BufferBase const &	stagingBuffer,
		ashes::Queue const &	queue,
		ashes::CommandPool const &	commandPool,
		uint32_t	offset,
		VkPipelineStageFlags	flags,
		FramePassTimer const &	timer,
		uint32_t	index ) const

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

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

Paramètres

[in]	stagingBuffer	Le staging buffer utilisé pour effectuer le transfer.
[in]	queue	La file sur laquelle le transfert sera effectué.
[in]	commandPool	Le command pool depuis lequel le command buffer sera créé.
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.
[in]	timer	Le timer de passe de rendu.
[in]	index	L'indice de passe de rendu.

◆ upload() [5/5]

template<typename DataT >

void castor3d::UniformBufferT< DataT >::upload	(	VkDeviceSize	offset = 0u,
		VkDeviceSize	range = 1u ) const

Met en VRAM les données du tampon.

Paramètres

[in]	offset	L'offset à partir duquel la mémoire du tampon est mappée.
[in]	range	Le nombre d'éléments à mapper.

La documentation de cette classe a été générée à partir des fichiers suivants :

Castor3D/Buffer/BufferModule.hpp
Castor3D/Buffer/UniformBuffer.hpp

Fonctions membres publiques

Description détaillée

Documentation des constructeurs et destructeur

◆ UniformBufferT()

Documentation des fonctions membres

◆ download()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getDatas() [1/2]

◆ getDatas() [2/2]

◆ upload() [1/5]

◆ upload() [2/5]

◆ upload() [3/5]

◆ upload() [4/5]

◆ upload() [5/5]