Représentation d'une variable de shader à type variable. Plus de détails...

Graphe d'héritage de Castor3D::TPushUniform< Type >:

Graphe de collaboration de Castor3D::TPushUniform< Type >:

Types publics
using	type = TUniform< Type >

using	value_type = typename type::value_type

using	value_sub_type = typename type::value_sub_type

using	param_type = typename type::param_type

using	return_type = typename type::return_type

using	return_const_type = typename type::return_const_type

using	typed_value = typename type::typed_value

Fonctions membres publiques
	TPushUniform (ShaderProgram &p_program, uint32_t p_occurences)
	Constructeur. Plus de détails...

virtual	~TPushUniform ()
	Destructeur. Plus de détails...

return_type &	GetValue ()
	Récupère la valeur. Plus de détails...

return_const_type const &	GetValue () const
	Récupère la valeur. Plus de détails...

return_type &	GetValue (uint32_t p_index)
	Récupère la valeur à l'index donné Plus de détails...

return_const_type const &	GetValue (uint32_t p_index) const
	Récupère la valeur à l'index donné Plus de détails...

void	SetValue (param_type const &p_value)
	Définit la valeur de la variable. Plus de détails...

void	SetValue (param_type const &p_value, uint32_t p_index)
	Définit la valeur de la variable. Plus de détails...

void	SetValues (param_type const *p_values, size_t p_size)
	Définit les valeurs de la variable. Plus de détails...

template<size_t N>
void	SetValues (param_type const(&p_values)[N])
	Définit les valeurs de la variable. Plus de détails...

template<size_t N>
void	SetValues (std::array< param_type, N > const &p_values)
	Définit les valeurs de la variable. Plus de détails...

void	SetValues (std::vector< param_type > const &p_values)
	Définit les valeurs de la variable. Plus de détails...

return_type &	operator[] (uint32_t p_index)
	Opérateur d'accès de type tableau. Plus de détails...

return_const_type const &	operator[] (uint32_t p_index) const
	Opérateur d'accès de type tableau. Plus de détails...

type &	GetUniform ()

type const &	GetUniform () const

Uniform &	GetBaseUniform () override

Uniform const &	GetBaseUniform () const override

Fonctions membres publiques hérités de Castor3D::PushUniform
C3D_API	PushUniform (ShaderProgram &p_program)
	Constructeur. Plus de détails...

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

C3D_API bool	Initialise ()
	Initialise la variable. Plus de détails...

C3D_API void	Update ()
	Met à la jour la valeur de cette variable, dans le shader. Plus de détails...

ShaderProgram &	GetProgram ()

ShaderProgram const &	GetProgram () const

Attributs publics statiques
static constexpr auto	stride = type::stride

Attributs protégés
type	m_uniform

Attributs protégés hérités de Castor3D::PushUniform
ShaderProgram &	m_program

Description détaillée

template<UniformType Type>
class Castor3D::TPushUniform< Type >

Représentation d'une variable de shader à type variable.

Auteur: Sylvain DOREMUS

Version: 0.6.1.0

Date: 14/08/2010

Documentation des définitions de type membres

◆ param_type

template<UniformType Type>

using Castor3D::TPushUniform< Type >::param_type = typename type::param_type

◆ return_const_type

template<UniformType Type>

using Castor3D::TPushUniform< Type >::return_const_type = typename type::return_const_type

◆ return_type

template<UniformType Type>

using Castor3D::TPushUniform< Type >::return_type = typename type::return_type

◆ type

template<UniformType Type>

using Castor3D::TPushUniform< Type >::type = TUniform< Type >

◆ typed_value

template<UniformType Type>

using Castor3D::TPushUniform< Type >::typed_value = typename type::typed_value

◆ value_sub_type

template<UniformType Type>

using Castor3D::TPushUniform< Type >::value_sub_type = typename type::value_sub_type

◆ value_type

template<UniformType Type>

using Castor3D::TPushUniform< Type >::value_type = typename type::value_type

Documentation des constructeurs et destructeur

◆ TPushUniform()

template<UniformType Type>

Castor3D::TPushUniform< Type >::TPushUniform	(	ShaderProgram &	p_program,
		uint32_t	p_occurences
	)

Constructeur.

Paramètres

[in]	p_program	Le programme.
[in]	p_occurences	Les dimensions du tableau.

◆ ~TPushUniform()

template<UniformType Type>

virtual Castor3D::TPushUniform< Type >::~TPushUniform ( )

virtual

Destructeur.

Documentation des fonctions membres

◆ GetBaseUniform() [1/2]

template<UniformType Type>

Uniform& Castor3D::TPushUniform< Type >::GetBaseUniform ( )

inlineoverridevirtual

Renvoie: La variable uniforme.

Implémente Castor3D::PushUniform.

◆ GetBaseUniform() [2/2]

template<UniformType Type>

Uniform const& Castor3D::TPushUniform< Type >::GetBaseUniform ( ) const

inlineoverridevirtual

Renvoie: La variable uniforme.

Implémente Castor3D::PushUniform.

◆ GetUniform() [1/2]

template<UniformType Type>

type& Castor3D::TPushUniform< Type >::GetUniform ( )

inline

Renvoie: La programme parent.

◆ GetUniform() [2/2]

template<UniformType Type>

type const& Castor3D::TPushUniform< Type >::GetUniform ( ) const

inline

Renvoie: La programme parent.

◆ GetValue() [1/4]

template<UniformType Type>

return_type& Castor3D::TPushUniform< Type >::GetValue ( )

inline

Récupère la valeur.

Renvoie: Une référence sur la valeur

◆ GetValue() [2/4]

template<UniformType Type>

return_const_type const& Castor3D::TPushUniform< Type >::GetValue ( ) const

inline

Récupère la valeur.

Renvoie: Une référence constante sur la valeur

◆ GetValue() [3/4]

template<UniformType Type>

return_type& Castor3D::TPushUniform< Type >::GetValue ( uint32_t p_index )

inline

Récupère la valeur à l'index donné

Remarques: Vérifie que l'index est dans les bornes

Paramètres

[in] p_index L'indice

Renvoie: Une référence sur la valeur à l'index donné

◆ GetValue() [4/4]

template<UniformType Type>

return_const_type const& Castor3D::TPushUniform< Type >::GetValue ( uint32_t p_index ) const

inline

Récupère la valeur à l'index donné

Remarques: Vérifie que l'index est dans les bornes

Paramètres

[in] p_index L'indice

Renvoie: Une référence constante sur la valeur à l'index donné

◆ operator[]() [1/2]

template<UniformType Type>

return_type& Castor3D::TPushUniform< Type >::operator[] ( uint32_t p_index )

inline

Opérateur d'accès de type tableau.

Remarques: Ne vérifie pas que l'index est dans les bornes

Paramètres

[in] p_index L'indice

Renvoie: Une référence sur la valeur à l'index donné

◆ operator[]() [2/2]

template<UniformType Type>

return_const_type const& Castor3D::TPushUniform< Type >::operator[] ( uint32_t p_index ) const

inline

Opérateur d'accès de type tableau.

Remarques: Ne vérifie pas que l'index est dans les bornes

Paramètres

[in] p_index L'indice

Renvoie: Une référence constante sur la valeur à l'index donné

◆ SetValue() [1/2]

template<UniformType Type>

void Castor3D::TPushUniform< Type >::SetValue ( param_type const & p_value )

inline

Définit la valeur de la variable.

Paramètres

[in] p_value La valeur

Référencé par Castor3D::DoFillShaderDepthMaps().

Voici le graphe des appelants de cette fonction :

◆ SetValue() [2/2]

template<UniformType Type>

void Castor3D::TPushUniform< Type >::SetValue	(	param_type const &	p_value,
		uint32_t	p_index
	)

inline

Définit la valeur de la variable.

Paramètres

[in]	p_value	La valeur
[in]	p_index	L'index de la valeur à modifier

◆ SetValues() [1/4]

template<UniformType Type>

void Castor3D::TPushUniform< Type >::SetValues	(	param_type const *	p_values,
		size_t	p_size
	)

inline

Définit les valeurs de la variable.

Paramètres

[in]	p_values	Les valeurs.
[in]	p_size	Le nombre de valeurs.

◆ SetValues() [2/4]

template<UniformType Type>

template<size_t N>

void Castor3D::TPushUniform< Type >::SetValues ( param_type const(&) p_values[N] )

inline

Définit les valeurs de la variable.

Paramètres

[in] p_values Les valeurs.

◆ SetValues() [3/4]

template<UniformType Type>

template<size_t N>

void Castor3D::TPushUniform< Type >::SetValues ( std::array< param_type, N > const & p_values )

inline

Définit les valeurs de la variable.

Paramètres

[in] p_values Les valeurs.

◆ SetValues() [4/4]

template<UniformType Type>

void Castor3D::TPushUniform< Type >::SetValues ( std::vector< param_type > const & p_values )

inline

Définit les valeurs de la variable.

Paramètres

[in] p_values Les valeurs.

Documentation des données membres

◆ m_uniform

template<UniformType Type>

type Castor3D::TPushUniform< Type >::m_uniform

protected

Le programme parent.

◆ stride

template<UniformType Type>

constexpr auto Castor3D::TPushUniform< Type >::stride = type::stride

static

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Prerequisites/Castor3DPrerequisites_Shader.hpp
Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Shader/PushUniform.hpp

Types publics

Fonctions membres publiques

Attributs publics statiques

Attributs protégés

Description détaillée

template<UniformType Type> class Castor3D::TPushUniform< Type >

Documentation des définitions de type membres

◆ param_type

◆ return_const_type

◆ return_type

◆ type

◆ typed_value

◆ value_sub_type

◆ value_type

Documentation des constructeurs et destructeur

◆ TPushUniform()

◆ ~TPushUniform()

Documentation des fonctions membres

◆ GetBaseUniform() [1/2]

◆ GetBaseUniform() [2/2]

◆ GetUniform() [1/2]

◆ GetUniform() [2/2]

◆ GetValue() [1/4]

◆ GetValue() [2/4]

◆ GetValue() [3/4]

◆ GetValue() [4/4]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ SetValues() [1/4]

◆ SetValues() [2/4]

◆ SetValues() [3/4]

◆ SetValues() [4/4]

Documentation des données membres

◆ m_uniform

◆ stride

template<UniformType Type>
class Castor3D::TPushUniform< Type >