Variable simple à type variable. Plus de détails...

Graphe d'héritage de Castor3D::OneFrameVariable< T >:

Graphe de collaboration de Castor3D::OneFrameVariable< T >:

Fonctions membres publiques
	OneFrameVariable (ShaderProgram *p_program)
	Constructeur. Plus de détails...

	OneFrameVariable (ShaderProgram *p_program, uint32_t p_occurences)
	Constructeur. Plus de détails...

	OneFrameVariable (OneFrameVariable< T > const &p_object)
	Constructeur par copie. Plus de détails...

	OneFrameVariable (OneFrameVariable< T > &&p_object)
	Constructeur par déplacement. Plus de détails...

OneFrameVariable &	operator= (OneFrameVariable< T > const &p_object)
	Opérateur d'affectation par copie. Plus de détails...

OneFrameVariable &	operator= (OneFrameVariable< T > &&p_object)
	Opérateur d'affectation par déplacement. Plus de détails...

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

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

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

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

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

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

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

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

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

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

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

virtual uint32_t	size () const
	Récupère la taille en octets de la variable. Plus de détails...

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

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

eVARIABLE_TYPE	GetType () const
	Récupère le type de la variable. Plus de détails...

eFRAME_VARIABLE_TYPE	GetFullType () const
	Récupère le type complet de la variable. Plus de détails...

Castor::String	GetFullTypeName () const

Fonctions membres publiques hérités de Castor3D::TFrameVariable< T >
	TFrameVariable (ShaderProgram *p_program)
	Constructeur. Plus de détails...

	TFrameVariable (ShaderProgram *p_program, uint32_t p_occurences)
	Constructeur. Plus de détails...

	TFrameVariable (TFrameVariable< T > const &p_object)
	Constructeur par copie. Plus de détails...

	TFrameVariable (TFrameVariable< T > &&p_object)
	Constructeur par déplacement. Plus de détails...

TFrameVariable &	operator= (TFrameVariable< T > const &p_object)
	Opérateur d'affectation par copie. Plus de détails...

TFrameVariable &	operator= (TFrameVariable< T > &&p_object)
	Opérateur d'affectation par déplacement. Plus de détails...

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

Castor::String	GetDataTypeName () const
	Donne le type de données de la variable. Plus de détails...

virtual uint8_t const *const	const_ptr () const
	Récupère un pointeur sur les données de la variable. Plus de détails...

virtual void	link (uint8_t *p_buffer)
	Définit le buffer de cette variable. Plus de détails...

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

C3D_API	FrameVariable (ShaderProgram *p_program, uint32_t p_occurences)
	Constructeur. Plus de détails...

C3D_API	FrameVariable (FrameVariable const &p_object)
	Constructeur par copie. Plus de détails...

C3D_API	FrameVariable (FrameVariable &&p_object)
	Constructeur par déplacement. Plus de détails...

C3D_API FrameVariable &	operator= (FrameVariable const &p_object)
	Opérateur d'affectation par copie. Plus de détails...

C3D_API FrameVariable &	operator= (FrameVariable &&p_object)
	Opérateur d'affectation par déplacement. Plus de détails...

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

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

virtual C3D_API void	Cleanup ()=0
	Nettoie la variable. Plus de détails...

virtual C3D_API void	Bind ()=0
	Lie cette variable au shader. Plus de détails...

virtual C3D_API void	Unbind ()=0
	Délie cette variable du shader. Plus de détails...

virtual C3D_API void	SetValueStr (Castor::String const &p_value)
	Définit la valeur de cette variable à partir d'une chaîne. Plus de détails...

virtual C3D_API void	SetValueStr (Castor::String const &p_value, uint32_t p_index)
	Définit la valeur de cette variable à partir d'une chaîne. Plus de détails...

virtual void	SetName (Castor::String const &p_name)
	Définit le nom de la variable. Plus de détails...

Castor::String	GetName () const
	Récupère le nom de la variable. Plus de détails...

Castor::String	GetStrValue () const
	Récupère la valeur chaîne de la variable. Plus de détails...

Castor::String	GetStrValue (uint32_t p_index) const
	Récupère la valeur chaîne de la variable à l'index donné Plus de détails...

const uint32_t &	GetOccCount () const
	Récupère le nombre d'occurences. Plus de détails...

ShaderProgram *	GetProgram () const
	Récupère le programme parent. Plus de détails...

Fonctions membres publiques statiques
static eFRAME_VARIABLE_TYPE	GetFrameVariableType ()

static Castor::String	GetFrameVariableTypeName ()

static eVARIABLE_TYPE	GetVariableType ()
	Donne le type complet de la variable. Plus de détails...

Types protégés
typedef Castor::Policy< T >	policy

Types protégés hérités de Castor3D::TFrameVariable< T >
typedef Castor::Policy< T >	policy

Membres hérités additionnels
Fonctions membres protégées hérités de Castor3D::TFrameVariable< T >
void	DoCleanupBuffer ()

Attributs protégés hérités de Castor3D::TFrameVariable< T >
bool	m_bOwnBuffer
	Dit si la variable est responsable de son buffer. Plus de détails...

T *	m_values
	Le buffer contenant toutes les valeurs. Plus de détails...

Attributs protégés hérités de Castor3D::FrameVariable
Castor::String	m_name
	Le nom de la variable tel qu'il apparaît dans le shader. Plus de détails...

bool	m_changed
	Dit si la valeur de la variable a changé depuis la dernière exécution du shader. Plus de détails...

uint32_t	m_occurences
	Les dimensions du tableau si la variable représente un tableau. Plus de détails...

Castor::StringArray	m_strValue
	La valeur de la variable. Plus de détails...

ShaderProgram *	m_program
	Le programme parent. Plus de détails...

Description détaillée

template<typename T>
class Castor3D::OneFrameVariable< T >

Variable simple à type variable.

Auteur: Sylvain DOREMUS

Version: 0.6.1.0

Date: 14/08/2010

Documentation des définitions de type membres

template<typename T>

typedef Castor::Policy<T> Castor3D::OneFrameVariable< T >::policy

protected

Documentation des constructeurs et destructeur

template<typename T>

Castor3D::OneFrameVariable< T >::OneFrameVariable ( ShaderProgram * p_program )

Constructeur.

Paramètres

[in] p_program Le programme

template<typename T>

Castor3D::OneFrameVariable< T >::OneFrameVariable	(	ShaderProgram *	p_program,
		uint32_t	p_occurences
	)

Constructeur.

Paramètres

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

template<typename T>

Castor3D::OneFrameVariable< T >::OneFrameVariable ( OneFrameVariable< T > const & p_object )

Constructeur par copie.

Paramètres

[in] p_object L'objet à copier

template<typename T>

Castor3D::OneFrameVariable< T >::OneFrameVariable ( OneFrameVariable< T > && p_object )

Constructeur par déplacement.

Paramètres

[in] p_object L'objet à déplacer

template<typename T>

virtual Castor3D::OneFrameVariable< T >::~OneFrameVariable ( )

virtual

Destructeur.

Documentation des fonctions membres

template<typename T>

static eFRAME_VARIABLE_TYPE Castor3D::OneFrameVariable< T >::GetFrameVariableType ( )

inlinestatic

Référencé par Castor3D::OneFrameVariable< T >::GetFullType(), et Castor3D::OneFrameVariable< T >::SetValues().

Voici le graphe des appelants de cette fonction :

template<typename T>

static Castor::String Castor3D::OneFrameVariable< T >::GetFrameVariableTypeName ( )

inlinestatic

Référencé par Castor3D::OneFrameVariable< T >::GetFullTypeName(), et Castor3D::OneFrameVariable< T >::SetValues().

Voici le graphe des appelants de cette fonction :

template<typename T>

eFRAME_VARIABLE_TYPE Castor3D::OneFrameVariable< T >::GetFullType ( ) const

inlinevirtual

Récupère le type complet de la variable.

Renvoie: Le type

Implémente Castor3D::FrameVariable.

Références Castor3D::OneFrameVariable< T >::GetFrameVariableType().

Voici le graphe d'appel pour cette fonction :

template<typename T>

Castor::String Castor3D::OneFrameVariable< T >::GetFullTypeName ( ) const

inlinevirtual

Implémente Castor3D::FrameVariable.

Références Castor3D::OneFrameVariable< T >::GetFrameVariableTypeName().

Voici le graphe d'appel pour cette fonction :

template<typename T>

eVARIABLE_TYPE Castor3D::OneFrameVariable< T >::GetType ( ) const

inlinevirtual

Récupère le type de la variable.

Renvoie: Le type de variable

Implémente Castor3D::FrameVariable.

Références Castor3D::OneFrameVariable< T >::GetVariableType().

Voici le graphe d'appel pour cette fonction :

template<typename T>

T& Castor3D::OneFrameVariable< T >::GetValue ( )

inline

Récupère la valeur.

Renvoie: Une référence sur la valeur

template<typename T>

T const& Castor3D::OneFrameVariable< T >::GetValue ( ) const

inline

Récupère la valeur.

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

template<typename T>

T& Castor3D::OneFrameVariable< T >::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é

template<typename T>

T const& Castor3D::OneFrameVariable< T >::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é

template<typename T>

static eVARIABLE_TYPE Castor3D::OneFrameVariable< T >::GetVariableType ( )

inlinestatic

Donne le type complet de la variable.

Renvoie: Le type complet

Références Castor3D::eVARIABLE_TYPE_ONE.

Référencé par Castor3D::OneFrameVariable< T >::GetType().

Voici le graphe des appelants de cette fonction :

template<typename T>

OneFrameVariable& Castor3D::OneFrameVariable< T >::operator= ( OneFrameVariable< T > const & p_object )

Opérateur d'affectation par copie.

Paramètres

[in] p_object L'objet à copier

Renvoie: Une référence sur cet objet

template<typename T>

OneFrameVariable& Castor3D::OneFrameVariable< T >::operator= ( OneFrameVariable< T > && p_object )

Opérateur d'affectation par déplacement.

Paramètres

[in] p_object L'objet à déplacer

Renvoie: Une référence sur cet objet

template<typename T>

T& Castor3D::OneFrameVariable< T >::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é

Références Castor3D::TFrameVariable< T >::m_values.

template<typename T>

T const& Castor3D::OneFrameVariable< T >::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é

Références Castor3D::TFrameVariable< T >::m_values.

template<typename T>

void Castor3D::OneFrameVariable< T >::SetValue ( T const & p_value )

inline

Définit la valeur de la variable.

Paramètres

[in] p_value La valeur

template<typename T>

void Castor3D::OneFrameVariable< T >::SetValue	(	T 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

template<typename T>

void Castor3D::OneFrameVariable< T >::SetValues	(	T 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.

Référencé par Castor3D::OneFrameVariable< T >::SetValues().

Voici le graphe des appelants de cette fonction :

template<typename T>

template<size_t N>

void Castor3D::OneFrameVariable< T >::SetValues ( T const (&) p_values[N] )

inline

Définit les valeurs de la variable.

Paramètres

[in] p_values Les valeurs.

Références Castor3D::OneFrameVariable< T >::SetValues().

Voici le graphe d'appel pour cette fonction :

template<typename T>

template<size_t N>

void Castor3D::OneFrameVariable< T >::SetValues ( std::array< T, N > const & p_values )

inline

Définit les valeurs de la variable.

Paramètres

[in] p_values Les valeurs.

Références Castor3D::OneFrameVariable< T >::SetValues().

Voici le graphe d'appel pour cette fonction :

template<typename T>

void Castor3D::OneFrameVariable< T >::SetValues ( std::vector< T > const & p_values )

inline

Définit les valeurs de la variable.

Paramètres

[in] p_values Les valeurs.

Références Castor3D::OneFrameVariable< T >::GetFrameVariableType(), Castor3D::OneFrameVariable< T >::GetFrameVariableTypeName(), Castor3D::OneFrameVariable< T >::SetValues(), et Castor3D::OneFrameVariable< T >::size().

Voici le graphe d'appel pour cette fonction :

template<typename T>

virtual uint32_t Castor3D::OneFrameVariable< T >::size ( ) const

virtual

Récupère la taille en octets de la variable.

Renvoie: La taille

Implémente Castor3D::FrameVariable.

Référencé par Castor3D::OneFrameVariable< T >::SetValues().

Voici le graphe des appelants de cette fonction :

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

Y:/software/Castor3D/source/Core/Castor3D/Src/Castor3DPrerequisites_Shader.hpp
Y:/software/Castor3D/source/Core/Castor3D/Src/OneFrameVariable.hpp

Fonctions membres publiques

Fonctions membres publiques statiques

Types protégés

Membres hérités additionnels

Description détaillée

template<typename T> class Castor3D::OneFrameVariable< T >

Documentation des définitions de type membres

Documentation des constructeurs et destructeur

Documentation des fonctions membres

template<typename T>
class Castor3D::OneFrameVariable< T >