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

#include <LightBuffer.hpp>

Classes
struct	Float4
struct	Float4x4
struct	LightData
union	SpecLight

Types publics
using	LightsData = castor::ArrayView< LightData >

Fonctions membres publiques
C3D_API	LightBuffer (Engine &engine, RenderDevice const &device, uint32_t count)
	Constructeur. Plus de détails...
C3D_API void	addLight (Light &light)
	Ajoute une source lumineuse au tampon. Plus de détails...
C3D_API void	removeLight (Light &light)
	Supprime une source lumineuse du tampon. Plus de détails...
C3D_API void	update (CpuUpdater &updater)
	Met à jour le tampon au niveau CPU. Plus de détails...
C3D_API void	upload (ashes::CommandBuffer const &commandBuffer)
	Uploade le tampon en VRAM. Plus de détails...
C3D_API VkDescriptorSetLayoutBinding	createLayoutBinding (uint32_t binding) const
	Crée une attache de layout de set de descripteurs. Plus de détails...
C3D_API void	createPassBinding (crg::FramePass &pass, uint32_t binding) const
	Crée une attache de frame pass. Plus de détails...
C3D_API ashes::WriteDescriptorSet	getBinding (uint32_t binding) const
	Crée le descriptor write pour ce tampon. Plus de détails...
C3D_API ashes::WriteDescriptorSet	getBinding (uint32_t binding, VkDeviceSize offset, VkDeviceSize size) const
	Crée le descriptor write pour ce tampon. Plus de détails...
C3D_API void	createBinding (ashes::DescriptorSet &descriptorSet, VkDescriptorSetLayoutBinding const &binding) const
	Crée une attache de set de descripteurs au point donné. Plus de détails...
C3D_API LightData &	getData (Light const &light)
	Le pointeur sur les données pour la source lumineuse donnée. Plus de détails...
C3D_API uint32_t	getIndex (Light const &light) const
	l'index de la source lumineuse dans le buffer. Plus de détails...
uint8_t *	getPtr ()
LightsArray	getLights (LightType type) const
LightData &	operator[] (size_t index)
LightData const &	operator[] (size_t index) const

Attributs publics statiques
static constexpr uint32_t	DataSize = sizeof( LightData )

Documentation des définitions de type membres

LightsData

using castor3d::LightBuffer::LightsData = castor::ArrayView< LightData >

Documentation des constructeurs et destructeur

LightBuffer()

C3D_API castor3d::LightBuffer::LightBuffer	(	Engine &	engine,
		RenderDevice const &	device,
		uint32_t	count
	)

Constructeur.

Paramètres

[in]	engine	Le moteur.
[in]	device	Le device GPU.
[in]	count	Le nombre maximal de passes.

Documentation des fonctions membres

addLight()

C3D_API void castor3d::LightBuffer::addLight

(

Light &

light

)

Ajoute une source lumineuse au tampon.

Paramètres

[in]

light

La source lumineuse.

createBinding()

C3D_API void castor3d::LightBuffer::createBinding	(	ashes::DescriptorSet &	descriptorSet,
		VkDescriptorSetLayoutBinding const &	binding
	)		const

Crée une attache de set de descripteurs au point donné.

Paramètres

[in]	descriptorSet	Le set de descripteurs recevant l'attache.
[in]	binding	L'attache de layout de set de descripteurs.

createLayoutBinding()

C3D_API VkDescriptorSetLayoutBinding castor3d::LightBuffer::createLayoutBinding

(

uint32_t

binding

)

const

Crée une attache de layout de set de descripteurs.

createPassBinding()

C3D_API void castor3d::LightBuffer::createPassBinding	(	crg::FramePass &	pass,
		uint32_t	binding
	)		const

Crée une attache de frame pass.

getBinding() [1/2]

C3D_API ashes::WriteDescriptorSet castor3d::LightBuffer::getBinding

(

uint32_t

binding

)

const

Crée le descriptor write pour ce tampon.

getBinding() [2/2]

C3D_API ashes::WriteDescriptorSet castor3d::LightBuffer::getBinding	(	uint32_t	binding,
		VkDeviceSize	offset,
		VkDeviceSize	size
	)		const

Crée le descriptor write pour ce tampon.

getData()

C3D_API LightData & castor3d::LightBuffer::getData

(

Light const &

light

)

Le pointeur sur les données pour la source lumineuse donnée.

getIndex()

C3D_API uint32_t castor3d::LightBuffer::getIndex

(

Light const &

light

)

const

l'index de la source lumineuse dans le buffer.

getLights()

LightsArray castor3d::LightBuffer::getLights ( LightType  type ) const

inline

getPtr()

uint8_t * castor3d::LightBuffer::getPtr ( )

inline

Références castor3d::ShaderBuffer::getPtr().

Voici le graphe d'appel pour cette fonction :

operator[]() [1/2]

LightData & castor3d::LightBuffer::operator[] ( size_t  index )

inline

operator[]() [2/2]

LightData const & castor3d::LightBuffer::operator[] ( size_t  index ) const

inline

removeLight()

C3D_API void castor3d::LightBuffer::removeLight

(

Light &

light

)

Supprime une source lumineuse du tampon.

Paramètres

[in]

light

La source lumineuse.

update()

C3D_API void castor3d::LightBuffer::update

(

CpuUpdater &

updater

)

Met à jour le tampon au niveau CPU.

Paramètres

[in,out]

updater

Les données de mise à jour.

upload()

C3D_API void castor3d::LightBuffer::upload

(

ashes::CommandBuffer const &

commandBuffer

)

Uploade le tampon en VRAM.

Paramètres

[in]

commandBuffer

Reçoit les commandes d'upload.

Documentation des données membres

DataSize

constexpr uint32_t castor3d::LightBuffer::DataSize = sizeof( LightData )

staticconstexpr

---

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

• Shader/ShaderBuffers/LightBuffer.hpp