#include <UniformBufferBase.hpp>

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

Fonctions membres publiques
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

Documentation des constructeurs et destructeur

◆ UniformBufferBase()

C3D_API castor3d::UniformBufferBase::UniformBufferBase	(	RenderSystem const &	renderSystem,
		VkDeviceSize	elemCount,
		VkDeviceSize	elemSize,
		VkBufferUsageFlags	usage,
		VkMemoryPropertyFlags	flags,
		castor::String	debugName,
		ashes::QueueShare	sharingMode = {} )

Constructeur.

Paramètres

[in]	renderSystem	Le RenderSystem.
[in]	elemCount	Le nombre d'éléments.
[in]	elemSize	La taille d'un élément.
[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.

◆ ~UniformBufferBase()

virtual C3D_API castor3d::UniformBufferBase::~UniformBufferBase ( )

virtualdefaultnoexcept

Destructeur.

Documentation des fonctions membres

◆ allocate()

C3D_API uint32_t castor3d::UniformBufferBase::allocate ( )

noexcept

Alloue une zone mémoire pour un CPU buffer.

Renvoie: L'offset de la zone mémoire.

◆ cleanup()

C3D_API void castor3d::UniformBufferBase::cleanup ( )

noexcept

Nettoie le tampon GPU.

◆ deallocate()

C3D_API void castor3d::UniformBufferBase::deallocate ( uint32_t offset )

Désalloue de la mémoire.

Paramètres

[in] offset L'offset de la zone mémoire.

◆ download() [1/2]

void castor3d::UniformBufferBase::download	(	ashes::BufferBase const &	stagingBuffer,
		ashes::Queue const &	queue,
		ashes::CommandPool const &	commandPool,
		ashes::ByteArray &	data,
		uint32_t	offset,
		VkPipelineStageFlags	flags,
		FramePassTimer &	timer ) const

inline

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]	data	Reçoit les données transférées, packed.
[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.

Références download().

Voici le graphe d'appel pour cette fonction :

◆ download() [2/2]

C3D_API void castor3d::UniformBufferBase::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.

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]	data	Reçoit les données transférées, packed.
[in]	size	La taille des donné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.

Référencé par download().

Voici le graphe des appelants de cette fonction :

◆ getAlignedSize() [1/2]

uint32_t castor3d::UniformBufferBase::getAlignedSize ( ) const

inline

Renvoie: La taille alignée d'un élément.

Références getAlignedSize(), et getElementSize().

Référencé par getAlignedSize(), et getAlignedSize().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ getAlignedSize() [2/2]

uint32_t castor3d::UniformBufferBase::getAlignedSize ( uint32_t size ) const

inline

Récupère la taille alignée d'un élément.

Paramètres

[in] size La taille d'un élément.

Renvoie: La taille alignée.

Références getAlignedSize(), et getBuffer().

Voici le graphe d'appel pour cette fonction :

◆ getBuffer() [1/2]

ashes::UniformBuffer & castor3d::UniformBufferBase::getBuffer ( )

inline

Renvoie: Le tampon interne.

◆ getBuffer() [2/2]

ashes::UniformBuffer const & castor3d::UniformBufferBase::getBuffer ( ) const

inline

Renvoie: Le tampon interne.

Référencé par getAlignedSize(), et getElementSize().

Voici le graphe des appelants de cette fonction :

◆ getElementSize()

uint32_t castor3d::UniformBufferBase::getElementSize ( ) const

inline

Renvoie: La taille d'un élément du tampon.

Références getBuffer(), et getElementSize().

Référencé par getAlignedSize(), et getElementSize().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ hasAvailable()

C3D_API bool castor3d::UniformBufferBase::hasAvailable ( ) const

noexcept

Renvoie: true s'il y a assez de mémoire restante pour un nouvel élément.

◆ hasBuffer()

bool castor3d::UniformBufferBase::hasBuffer ( ) const

inline

Renvoie: false si le tampon interne n'existe pas.

◆ initialise() [1/2]

C3D_API uint32_t castor3d::UniformBufferBase::initialise ( RenderDevice const & device )

Initialise le tampon GPU.

Paramètres

[in] device Le device GPU.

◆ initialise() [2/2]

C3D_API uint32_t castor3d::UniformBufferBase::initialise	(	RenderDevice const &	device,
		ashes::QueueShare	sharingMode )

Initialise le tampon GPU.

Paramètres

[in]	device	Le device GPU.
[in]	sharingMode	Le mode de partage du tampon.

◆ upload() [1/8]

void castor3d::UniformBufferBase::upload	(	ashes::BufferBase const &	stagingBuffer,
		ashes::CommandBuffer const &	commandBuffer,
		ashes::ByteArray const &	data,
		uint32_t	offset,
		VkPipelineStageFlags	flags ) const

inline

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]	data	Les données à transférer, packed (elles seront alignées lors de l'upload).
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.

Références upload().

Voici le graphe d'appel pour cette fonction :

◆ upload() [2/8]

void castor3d::UniformBufferBase::upload	(	ashes::BufferBase const &	stagingBuffer,
		ashes::CommandBuffer const &	commandBuffer,
		ashes::ByteArray const &	data,
		uint32_t	offset,
		VkPipelineStageFlags	flags,
		FramePassTimer &	timer ) const

inline

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]	data	Les données à transférer, packed (elles seront alignées lors de l'upload).
[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.

Références upload().

Voici le graphe d'appel pour cette fonction :

◆ upload() [3/8]

C3D_API void castor3d::UniformBufferBase::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.

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]	data	Les données à transférer, packed (elles seront alignées lors de l'upload).
[in]	size	La taille des données.
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.

◆ upload() [4/8]

C3D_API void castor3d::UniformBufferBase::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.

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]	data	Les données à transférer, packed (elles seront alignées lors de l'upload).
[in]	size	La taille des donné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.

◆ upload() [5/8]

void castor3d::UniformBufferBase::upload	(	ashes::BufferBase const &	stagingBuffer,
		ashes::Queue const &	queue,
		ashes::CommandPool const &	commandPool,
		ashes::ByteArray const &	data,
		uint32_t	offset,
		VkPipelineStageFlags	flags ) const

inline

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]	data	Les données à transférer, packed (elles seront alignées lors de l'upload).
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.

Références upload().

Voici le graphe d'appel pour cette fonction :

◆ upload() [6/8]

void castor3d::UniformBufferBase::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

inline

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]	data	Les données à transférer, packed (elles seront alignées lors de l'upload).
[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.

Références upload().

Voici le graphe d'appel pour cette fonction :

◆ upload() [7/8]

C3D_API void castor3d::UniformBufferBase::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.

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]	data	Les données à transférer, packed (elles seront alignées lors de l'upload).
[in]	size	La taille des données.
[in]	offset	L'offset de départ.
[in]	flags	Les indicateurs de pipeline stage pour la barrière mémoire de sortie.

Référencé par upload(), upload(), upload(), et upload().

Voici le graphe des appelants de cette fonction :

◆ upload() [8/8]

C3D_API void castor3d::UniformBufferBase::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.

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]	data	Les données à transférer, packed (elles seront alignées lors de l'upload).
[in]	size	La taille des donné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.

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

Castor3D/Buffer/UniformBufferBase.hpp

Fonctions membres publiques

Documentation des constructeurs et destructeur

◆ UniformBufferBase()

◆ ~UniformBufferBase()

Documentation des fonctions membres

◆ allocate()

◆ cleanup()

◆ deallocate()

◆ download() [1/2]

◆ download() [2/2]

◆ getAlignedSize() [1/2]

◆ getAlignedSize() [2/2]

◆ getBuffer() [1/2]

◆ getBuffer() [2/2]

◆ getElementSize()

◆ hasAvailable()

◆ hasBuffer()

◆ initialise() [1/2]

◆ initialise() [2/2]

◆ upload() [1/8]

◆ upload() [2/8]

◆ upload() [3/8]

◆ upload() [4/8]

◆ upload() [5/8]

◆ upload() [6/8]

◆ upload() [7/8]

◆ upload() [8/8]