Castor3D: Référence de la classe castor3d::CameraUbo

Castor3D 0.16.0

Multiplatform 3D engine

#include <CameraUbo.hpp>

Types publics
using	Configuration = CameraUboConfiguration

Fonctions membres publiques
C3D_API	CameraUbo (CameraUbo const &rhs)=delete

C3D_API CameraUbo &	operator= (CameraUbo const &rhs)=delete

C3D_API	CameraUbo (CameraUbo &&rhs) noexcept=default

C3D_API CameraUbo &	operator= (CameraUbo &&rhs) noexcept=delete

C3D_API	CameraUbo (RenderDevice const &device)

C3D_API	~CameraUbo () noexcept

C3D_API Configuration &	cpuUpdate (castor::Size const &size, Camera const &camera, castor::Matrix4x4f const &view, castor::Matrix4x4f const &projection, uint32_t debugIndex, castor::Point2f const &jitter=castor::Point2f{})
	Met à jour l'UBO avec les valeurs données.

C3D_API Configuration &	cpuUpdate (Camera const &camera, castor::Matrix4x4f const &view, castor::Matrix4x4f const &projection, uint32_t debugIndex, bool safeBanded, castor::Point2f const &jitter=castor::Point2f{})
	Met à jour l'UBO avec les valeurs données.

C3D_API Configuration &	cpuUpdate (Camera const &camera, uint32_t debugIndex, bool safeBanded, castor::Point2f const &jitter=castor::Point2f{})
	Met à jour l'UBO avec les valeurs données.

C3D_API Configuration &	cpuUpdate (castor::Size const &size, Camera const &camera, uint32_t debugIndex, bool safeBanded, castor::Point2f const &jitter=castor::Point2f{})
	Met à jour l'UBO avec les valeurs données.

C3D_API Configuration &	cpuUpdate (castor::Size const &size, castor::Matrix4x4f const &view, castor::Matrix4x4f const &projection, uint32_t debugIndex, Frustum const &frustum, castor::Point2f const &jitter=castor::Point2f{})
	Met à jour l'UBO avec les valeurs données.

C3D_API Configuration &	cpuUpdate (castor::Size const &size, castor::Matrix4x4f const &projection, uint32_t debugIndex)
	Met à jour l'UBO avec les valeurs données.

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

void	createSizedBinding (ashes::DescriptorSet &descriptorSet, VkDescriptorSetLayoutBinding const &layoutBinding) const

ashes::WriteDescriptorSet	getDescriptorWrite (uint32_t dstBinding, uint32_t dstArrayElement=0u) const

UniformBufferOffsetT< Configuration > const &	getUbo () const

Documentation des définitions de type membres

◆ Configuration

using castor3d::CameraUbo::Configuration = CameraUboConfiguration

Documentation des constructeurs et destructeur

◆ CameraUbo() [1/3]

C3D_API castor3d::CameraUbo::CameraUbo ( CameraUbo const & rhs )

delete

◆ CameraUbo() [2/3]

C3D_API castor3d::CameraUbo::CameraUbo ( CameraUbo && rhs )

defaultnoexcept

◆ CameraUbo() [3/3]

C3D_API castor3d::CameraUbo::CameraUbo ( RenderDevice const & device )

explicit

◆ ~CameraUbo()

C3D_API castor3d::CameraUbo::~CameraUbo ( )

noexcept

Documentation des fonctions membres

◆ cpuUpdate() [1/6]

C3D_API Configuration & castor3d::CameraUbo::cpuUpdate	(	Camera const &	camera,
		castor::Matrix4x4f const &	view,
		castor::Matrix4x4f const &	projection,
		uint32_t	debugIndex,
		bool	safeBanded,
		castor::Point2f const &	jitter = castor::Point2f{} )

Met à jour l'UBO avec les valeurs données.

Paramètres

[in]	camera	La caméra contenant les données.
[in]	view	La nouvelle matrice de vue.
[in]	projection	La nouvelle matrice de projection.
[in]	debugIndex	L'indice des données de debug actuellement sélectionnées.
[in]	safeBanded	`true` pour utiliser la taille avec les safebands.
[in]	jitter	La valeur de jittering.

◆ cpuUpdate() [2/6]

C3D_API Configuration & castor3d::CameraUbo::cpuUpdate	(	Camera const &	camera,
		uint32_t	debugIndex,
		bool	safeBanded,
		castor::Point2f const &	jitter = castor::Point2f{} )

Met à jour l'UBO avec les valeurs données.

Paramètres

[in]	camera	La caméra contenant les données.
[in]	debugIndex	L'indice des données de debug actuellement sélectionnées.
[in]	safeBanded	`true` pour utiliser la taille et la matrice de projection avec les safebands.
[in]	jitter	La valeur de jittering.

◆ cpuUpdate() [3/6]

C3D_API Configuration & castor3d::CameraUbo::cpuUpdate	(	castor::Size const &	size,
		Camera const &	camera,
		castor::Matrix4x4f const &	view,
		castor::Matrix4x4f const &	projection,
		uint32_t	debugIndex,
		castor::Point2f const &	jitter = castor::Point2f{} )

Met à jour l'UBO avec les valeurs données.

Paramètres

[in]	size	Les dimensions du rendu.
[in]	camera	La caméra contenant les données.
[in]	view	La nouvelle matrice de vue.
[in]	projection	La nouvelle matrice de projection.
[in]	debugIndex	L'indice des données de debug actuellement sélectionnées.
[in]	jitter	La valeur de jittering.

◆ cpuUpdate() [4/6]

C3D_API Configuration & castor3d::CameraUbo::cpuUpdate	(	castor::Size const &	size,
		Camera const &	camera,
		uint32_t	debugIndex,
		bool	safeBanded,
		castor::Point2f const &	jitter = castor::Point2f{} )

Met à jour l'UBO avec les valeurs données.

Paramètres

[in]	size	Les dimensions du rendu.
[in]	camera	La caméra contenant les données.
[in]	debugIndex	L'indice des données de debug actuellement sélectionnées.
[in]	safeBanded	`true` pour utiliser la matrice de projection avec les safebands.
[in]	jitter	La valeur de jittering.

◆ cpuUpdate() [5/6]

C3D_API Configuration & castor3d::CameraUbo::cpuUpdate	(	castor::Size const &	size,
		castor::Matrix4x4f const &	projection,
		uint32_t	debugIndex )

Met à jour l'UBO avec les valeurs données.

Remarques: La matrice de vue ne sera pas mise à jour.

Paramètres

[in]	size	Les dimensions du rendu.
[in]	projection	La nouvelle matrice de projection.
[in]	debugIndex	L'indice des données de debug actuellement sélectionnées.

◆ cpuUpdate() [6/6]

C3D_API Configuration & castor3d::CameraUbo::cpuUpdate	(	castor::Size const &	size,
		castor::Matrix4x4f const &	view,
		castor::Matrix4x4f const &	projection,
		uint32_t	debugIndex,
		Frustum const &	frustum,
		castor::Point2f const &	jitter = castor::Point2f{} )

Met à jour l'UBO avec les valeurs données.

Paramètres

[in]	size	Les dimensions du rendu.
[in]	view	La nouvelle matrice de vue.
[in]	projection	La nouvelle matrice de projection.
[in]	debugIndex	L'indice des données de debug actuellement sélectionnées.
[in]	frustum	Le frustum depuis lequel les plans sont copiés.
[in]	jitter	La valeur de jittering.

◆ createPassBinding()

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

inline

Références castor3d::UniformBufferOffsetT< DataT >::createPassBinding().

Voici le graphe d'appel pour cette fonction :

◆ createSizedBinding()

void castor3d::CameraUbo::createSizedBinding	(	ashes::DescriptorSet &	descriptorSet,
		VkDescriptorSetLayoutBinding const &	layoutBinding ) const

inline

Références castor3d::UniformBufferOffsetT< DataT >::createSizedBinding().

Voici le graphe d'appel pour cette fonction :

◆ getDescriptorWrite()

ashes::WriteDescriptorSet castor3d::CameraUbo::getDescriptorWrite	(	uint32_t	dstBinding,
		uint32_t	dstArrayElement = 0u ) const

inline

Références castor3d::UniformBufferOffsetT< DataT >::getDescriptorWrite().

Voici le graphe d'appel pour cette fonction :

◆ getUbo()

UniformBufferOffsetT< Configuration > const & castor3d::CameraUbo::getUbo ( ) const

inline

◆ operator=() [1/2]

C3D_API CameraUbo & castor3d::CameraUbo::operator= ( CameraUbo && rhs )

deletenoexcept

◆ operator=() [2/2]

C3D_API CameraUbo & castor3d::CameraUbo::operator= ( CameraUbo const & rhs )

delete

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

Castor3D/Shader/Ubos/CameraUbo.hpp