Castor3D  ..
Classes | Fonctions membres publiques | Attributs protégés | Liste de tous les membres
Référence de la classe Castor3D::Uniformabstract

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

+ Graphe d'héritage de Castor3D::Uniform:
+ Graphe de collaboration de Castor3D::Uniform:

Classes

class  TextWriter
 Loader de Uniform. Plus de détails...
 

Fonctions membres publiques

C3D_API Uniform (uint32_t p_occurences)
 Constructeur. Plus de détails...
 
virtual C3D_API ~Uniform ()
 Destructeur. Plus de détails...
 
C3D_API void SetStrValues (Castor::String const &p_value)
 Définit la valeur de la variable à partir d'une chaîne. Plus de détails...
 
C3D_API Castor::String GetStrValues () const
 Récupère les valeurs chaîne de la variable. Plus de détails...
 
C3D_API void SetStrValue (Castor::String const &p_value, uint32_t p_index=0)
 Définit la valeur de la variable à partir d'une chaîne. Plus de détails...
 
C3D_API Castor::String GetStrValue (uint32_t p_index=0) const
 Récupère la valeur chaîne de la variable. Plus de détails...
 
virtual C3D_API uint8_t const *const const_ptr () const =0
 
virtual C3D_API uint32_t size () const =0
 
virtual C3D_API VariableType GetType () const =0
 
virtual C3D_API UniformType GetFullType () const =0
 
virtual C3D_API Castor::String const & GetFullTypeName () const =0
 
virtual C3D_API Castor::String const & GetDataTypeName () const =0
 
virtual C3D_API void link (uint8_t *p_buffer, uint32_t p_stride=0u)=0
 Définit le tampon de cette variable. Plus de détails...
 
void SetName (Castor::String const &p_name)
 Définit le nom de la variable. Plus de détails...
 
Castor::String GetName () const
 
const uint32_t & GetOccCount () const
 
bool IsChanged () const
 
void SetChanged (bool p_value=true)
 

Attributs protégés

Castor::String m_name
 
bool m_changed
 
uint32_t m_occurences
 

Description détaillée

Représentation d'une variable de shader.

Auteur
Sylvain DOREMUS
Version
0.6.1.0
Date
14/08/2010
Remarques
Il s'agit d'une variable donnée à un shader au cours de son exécution.

Documentation des constructeurs et destructeur

◆ Uniform()

C3D_API Castor3D::Uniform::Uniform ( uint32_t  p_occurences)

Constructeur.

Paramètres
[in]p_occurencesLes dimensions du tableau.

◆ ~Uniform()

virtual C3D_API Castor3D::Uniform::~Uniform ( )
virtual

Destructeur.

Documentation des fonctions membres

◆ const_ptr()

virtual C3D_API uint8_t const* const Castor3D::Uniform::const_ptr ( ) const
pure virtual
Renvoie
Le pointeur sur les données de la variable.

Implémenté dans Castor3D::TUniform< Type >.

◆ GetDataTypeName()

virtual C3D_API Castor::String const& Castor3D::Uniform::GetDataTypeName ( ) const
pure virtual
Renvoie
Le nom du type de données de la variable.

Implémenté dans Castor3D::TUniform< Type >.

◆ GetFullType()

virtual C3D_API UniformType Castor3D::Uniform::GetFullType ( ) const
pure virtual

Implémenté dans Castor3D::TUniform< Type >.

◆ GetFullTypeName()

virtual C3D_API Castor::String const& Castor3D::Uniform::GetFullTypeName ( ) const
pure virtual

Implémenté dans Castor3D::TUniform< Type >.

◆ GetName()

Castor::String Castor3D::Uniform::GetName ( ) const
inline
Renvoie
Le nom de la variable, tel qu'il apparaît dans le programme shader.

Références m_name.

◆ GetOccCount()

const uint32_t& Castor3D::Uniform::GetOccCount ( ) const
inline
Renvoie
Le nombre d'occurences.

Références m_occurences.

◆ GetStrValue()

C3D_API Castor::String Castor3D::Uniform::GetStrValue ( uint32_t  p_index = 0) const

Récupère la valeur chaîne de la variable.

Paramètres
[in]p_indexL'indice de la valeur.
Renvoie
La valeur chaîne de la variable.

◆ GetStrValues()

C3D_API Castor::String Castor3D::Uniform::GetStrValues ( ) const

Récupère les valeurs chaîne de la variable.

◆ GetType()

virtual C3D_API VariableType Castor3D::Uniform::GetType ( ) const
pure virtual

Implémenté dans Castor3D::TUniform< Type >.

◆ IsChanged()

bool Castor3D::Uniform::IsChanged ( ) const
inline
Renvoie
Le statut de changement.

Références m_changed.

◆ link()

virtual C3D_API void Castor3D::Uniform::link ( uint8_t *  p_buffer,
uint32_t  p_stride = 0u 
)
pure virtual

Définit le tampon de cette variable.

Remarques
La variable perd la responsabilité de son tampon.
Paramètres
[in]p_bufferLe tampon.
[in]p_strideLa distance binaire entre chaque valeur dans le tampon.

Implémenté dans Castor3D::TUniform< Type >.

◆ SetChanged()

void Castor3D::Uniform::SetChanged ( bool  p_value = true)
inline
Renvoie
Définit statut de changement.
Paramètres
[in]p_valueLa nouvelle valeur.

Références m_changed.

◆ SetName()

void Castor3D::Uniform::SetName ( Castor::String const &  p_name)
inline

Définit le nom de la variable.

Paramètres
[in]p_nameLe nom.

Références m_name.

◆ SetStrValue()

C3D_API void Castor3D::Uniform::SetStrValue ( Castor::String const &  p_value,
uint32_t  p_index = 0 
)

Définit la valeur de la variable à partir d'une chaîne.

Paramètres
[in]p_valueLa chaîne.
[in]p_indexL'indice de la valeur.

◆ SetStrValues()

C3D_API void Castor3D::Uniform::SetStrValues ( Castor::String const &  p_value)

Définit la valeur de la variable à partir d'une chaîne.

Paramètres
[in]p_valueLa chaîne.

◆ size()

virtual C3D_API uint32_t Castor3D::Uniform::size ( ) const
pure virtual
Renvoie
La taille en octets de la variable.

Implémenté dans Castor3D::TUniform< Type >.

Documentation des données membres

◆ m_changed

bool Castor3D::Uniform::m_changed
mutableprotected

Dit si la valeur de la variable a changé depuis la dernière exécution du shader.

Référencé par IsChanged(), et SetChanged().

◆ m_name

Castor::String Castor3D::Uniform::m_name
protected

Le nom de la variable tel qu'il apparaît dans le shader.

Référencé par GetName(), et SetName().

◆ m_occurences

uint32_t Castor3D::Uniform::m_occurences
protected

Les dimensions du tableau si la variable représente un tableau.

Référencé par GetOccCount().


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