Castor3D  ..
Fonctions membres publiques | Fonctions membres publiques statiques | Types protégés | Liste de tous les membres
Référence du modèle de la classe Castor3D::OneFrameVariable< T >

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 (ShaderProgramBase *p_pProgram)
 Constructeur. Plus de détails...
 
 OneFrameVariable (ShaderProgramBase *p_pProgram, uint32_t p_uiOcc)
 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...
 
OneFrameVariableoperator= (OneFrameVariable< T > const &p_object)
 Opérateur d'affectation par copie. Plus de détails...
 
OneFrameVariableoperator= (OneFrameVariable< T > &&p_object)
 Opérateur d'affectation par déplacement. Plus de détails...
 
virtual ~OneFrameVariable ()
 Destructeur. Plus de détails...
 
T & operator[] (uint32_t p_uiIndex)
 Opérateur d'accès de type tableau. Plus de détails...
 
T const & operator[] (uint32_t p_uiIndex) const
 Opérateur d'accès de type tableau. Plus de détails...
 
T & GetValue () throw ( std::out_of_range )
 Récupère la valeur. Plus de détails...
 
T const & GetValue () const throw ( std::out_of_range )
 Récupère la valeur. Plus de détails...
 
T & GetValue (uint32_t p_uiIndex) throw ( std::out_of_range )
 Récupère la valeur à l'index donné Plus de détails...
 
T const & GetValue (uint32_t p_uiIndex) const throw ( std::out_of_range )
 Récupère la valeur à l'index donné 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...
 
void SetValue (T const &p_tValue)
 Définit la valeur de la variable. Plus de détails...
 
void SetValue (T const &p_tValue, uint32_t p_uiIndex)
 Définit la valeur 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...
 
- Fonctions membres publiques hérités de Castor3D::TFrameVariable< T >
 TFrameVariable (ShaderProgramBase *p_pProgram)
 Constructeur. Plus de détails...
 
 TFrameVariable (ShaderProgramBase *p_pProgram, uint32_t p_uiOcc)
 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...
 
TFrameVariableoperator= (TFrameVariable< T > const &p_object)
 Opérateur d'affectation par copie. Plus de détails...
 
TFrameVariableoperator= (TFrameVariable< T > &&p_object)
 Opérateur d'affectation par déplacement. Plus de détails...
 
virtual ~TFrameVariable ()
 Destructeur. Plus de détails...
 
Castor::String GetDataType () 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_pBuffer)
 Définit le buffer de cette variable. Plus de détails...
 
- Fonctions membres publiques hérités de Castor3D::FrameVariable
 FrameVariable (ShaderProgramBase *p_pProgram)
 Constructeur. Plus de détails...
 
 FrameVariable (ShaderProgramBase *p_pProgram, uint32_t p_uiOcc)
 Constructeur. Plus de détails...
 
 FrameVariable (FrameVariable const &p_object)
 Constructeur par copie. Plus de détails...
 
 FrameVariable (FrameVariable &&p_object)
 Constructeur par déplacement. Plus de détails...
 
FrameVariableoperator= (FrameVariable const &p_object)
 Opérateur d'affectation par copie. Plus de détails...
 
FrameVariableoperator= (FrameVariable &&p_object)
 Opérateur d'affectation par déplacement. Plus de détails...
 
virtual ~FrameVariable ()
 Destructeur. Plus de détails...
 
virtual bool Initialise ()=0
 Initialise la variable. Plus de détails...
 
virtual void Cleanup ()=0
 Nettoie la variable. Plus de détails...
 
virtual void Apply ()=0
 Applique cette variable. Plus de détails...
 
virtual void Bind ()=0
 Active cette variable. Plus de détails...
 
virtual void SetValueStr (Castor::String const &p_strValue)
 Définit la valeur de cette variable à partir d'une chaîne. Plus de détails...
 
virtual void SetValueStr (Castor::String const &p_strValue, uint32_t p_uiIndex)
 Définit la valeur de cette variable à partir d'une chaîne. Plus de détails...
 
virtual void SetName (Castor::String const &p_strName)
 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_uiIndex) 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...
 
ShaderProgramBaseGetProgram () const
 Récupère le programme parent. Plus de détails...
 

Fonctions membres publiques statiques

static eVARIABLE_TYPE GetVariableType ()
 Donne le type complet de la variable. Plus de détails...
 
static eFRAME_VARIABLE_TYPE GetFrameVariableType ()
 
- Fonctions membres publiques statiques hérités de Castor3D::TFrameVariable< T >
static Castor::String StGetDataType ()
 Donne le type de données 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

- Attributs publics statiques hérités de Castor3D::FrameVariable
static const Castor::String Names []
 Le nom des types de frame variable. Plus de détails...
 
- 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_pValues
 Le buffer contenant toutes les valeurs. Plus de détails...
 
- Attributs protégés hérités de Castor3D::FrameVariable
Castor::String m_strName
 Le nom de la variable tel qu'il apparaît dans le shader. Plus de détails...
 
bool m_bChanged
 Dit si la valeur de la variable a changé depuis la dernière exécution du shader. Plus de détails...
 
uint32_t m_uiOcc
 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...
 
ShaderProgramBasem_pProgram
 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 ( ShaderProgramBase p_pProgram)

Constructeur.

template<typename T >
Castor3D::OneFrameVariable< T >::OneFrameVariable ( ShaderProgramBase p_pProgram,
uint32_t  p_uiOcc 
)

Constructeur.

Paramètres
[in]p_uiOccLes dimensions du tableau
template<typename T >
Castor3D::OneFrameVariable< T >::OneFrameVariable ( OneFrameVariable< T > const &  p_object)

Constructeur par copie.

Paramètres
[in]p_objectL'objet à copier
template<typename T >
Castor3D::OneFrameVariable< T >::OneFrameVariable ( OneFrameVariable< T > &&  p_object)

Constructeur par déplacement.

Paramètres
[in]p_objectL'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().

+ 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 >
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 ( )
throw (std::out_of_range
)
inline

Récupère la valeur.

Renvoie
Une référence sur la valeur
template<typename T >
T const& Castor3D::OneFrameVariable< T >::GetValue ( ) const
throw (std::out_of_range
)
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_uiIndex)
throw (std::out_of_range
)
inline

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

Remarques
Vérifie que l'index est dans les bornes
Paramètres
[in]p_uiIndexL'indice
Renvoie
Une référence sur la valeur à l'index donné
template<typename T >
T const& Castor3D::OneFrameVariable< T >::GetValue ( uint32_t  p_uiIndex) const
throw (std::out_of_range
)
inline

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

Remarques
Vérifie que l'index est dans les bornes
Paramètres
[in]p_uiIndexL'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é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_objectL'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_objectL'objet à déplacer
Renvoie
Une référence sur cet objet
template<typename T >
T& Castor3D::OneFrameVariable< T >::operator[] ( uint32_t  p_uiIndex)
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_uiIndexL'indice
Renvoie
Une référence sur la valeur à l'index donné

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

template<typename T >
T const& Castor3D::OneFrameVariable< T >::operator[] ( uint32_t  p_uiIndex) 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_uiIndexL'indice
Renvoie
Une référence constante sur la valeur à l'index donné

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

template<typename T >
void Castor3D::OneFrameVariable< T >::SetValue ( T const &  p_tValue)
inline

Définit la valeur de la variable.

Paramètres
[in]p_tValueLa valeur
template<typename T >
void Castor3D::OneFrameVariable< T >::SetValue ( T const &  p_tValue,
uint32_t  p_uiIndex 
)
inline

Définit la valeur de la variable.

Paramètres
[in]p_tValueLa valeur
[in]p_uiIndexL'index de la valeur à modifier
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.


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