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

Graphe d'héritage de Castor3D::FrameVariable:

Graphe de collaboration de Castor3D::FrameVariable:

Classes
class	TextLoader
	Loader de FrameVariable. Plus de détails...

Fonctions membres publiques
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 eFRAME_VARIABLE_TYPE	GetFullType () const =0

virtual C3D_API eVARIABLE_TYPE	GetType () const =0

virtual C3D_API Castor::String	GetFullTypeName () const =0

virtual C3D_API Castor::String	GetDataTypeName () const =0
	Donne le nom du type de données de la variable. 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...

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

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

virtual void	link (uint8_t *p_buffer)=0
	Définit le buffer de cette variable. 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 protégées
virtual C3D_API void	DoSetValueStr (Castor::String const &p_value, uint32_t p_index)=0
	Définit la valeur de cette variable à partir d'une chaîne. Plus de détails...

Attributs protégés
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

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

C3D_API Castor3D::FrameVariable::FrameVariable ( ShaderProgram * p_program )

Constructeur.

Paramètres

[in] p_program Le programme

C3D_API Castor3D::FrameVariable::FrameVariable	(	ShaderProgram *	p_program,
		uint32_t	p_occurences
	)

Constructeur.

Paramètres

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

C3D_API Castor3D::FrameVariable::FrameVariable ( FrameVariable const & p_object )

Constructeur par copie.

Paramètres

[in] p_object L'objet à copier

C3D_API Castor3D::FrameVariable::FrameVariable ( FrameVariable && p_object )

Constructeur par déplacement.

Paramètres

[in] p_object L'objet à déplacer

virtual C3D_API Castor3D::FrameVariable::~FrameVariable ( )

virtual

Destructeur.

Documentation des fonctions membres

virtual C3D_API void Castor3D::FrameVariable::Bind ( )

pure virtual

Lie cette variable au shader.

virtual C3D_API void Castor3D::FrameVariable::Cleanup ( )

pure virtual

Nettoie la variable.

virtual uint8_t const* const Castor3D::FrameVariable::const_ptr ( ) const

pure virtual

Récupère un pointeur sur les données de la variable.

Renvoie: Le pointeur

Implémenté dans Castor3D::TFrameVariable< T >.

Référencé par GetStrValue().

Voici le graphe des appelants de cette fonction :

virtual C3D_API void Castor3D::FrameVariable::DoSetValueStr	(	Castor::String const &	p_value,
		uint32_t	p_index
	)

protectedpure virtual

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

Paramètres

[in]	p_index	L'index de la valeur
[in]	p_value	La chaîne contenant la valeur

Référencé par GetProgram().

Voici le graphe des appelants de cette fonction :

virtual C3D_API Castor::String Castor3D::FrameVariable::GetDataTypeName ( ) const

pure virtual

Donne le nom du type de données de la variable.

Renvoie: Le nom du type de données

Implémenté dans Castor3D::TFrameVariable< T >.

virtual C3D_API eFRAME_VARIABLE_TYPE Castor3D::FrameVariable::GetFullType ( ) const

pure virtual

Implémenté dans Castor3D::OneFrameVariable< T >, Castor3D::MatrixFrameVariable< T, Rows, Columns >, et Castor3D::PointFrameVariable< T, Count >.

virtual C3D_API Castor::String Castor3D::FrameVariable::GetFullTypeName ( ) const

pure virtual

Implémenté dans Castor3D::OneFrameVariable< T >, Castor3D::MatrixFrameVariable< T, Rows, Columns >, et Castor3D::PointFrameVariable< T, Count >.

Castor::String Castor3D::FrameVariable::GetName ( ) const

inline

Récupère le nom de la variable.

Renvoie: Le nom

Références m_name.

const uint32_t& Castor3D::FrameVariable::GetOccCount ( ) const

inline

Récupère le nombre d'occurences.

Renvoie: La valeur

Références m_occurences.

ShaderProgram* Castor3D::FrameVariable::GetProgram ( ) const

inline

Récupère le programme parent.

Renvoie: La programme

Références DoSetValueStr(), et m_program.

Voici le graphe d'appel pour cette fonction :

Castor::String Castor3D::FrameVariable::GetStrValue ( ) const

inline

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

Renvoie: La valeur

Références m_strValue.

Castor::String Castor3D::FrameVariable::GetStrValue ( uint32_t p_index ) const

inline

Récupère la valeur chaîne de la variable à l'index donné

Paramètres

[in] p_index L'index

Renvoie: La valeur

Références const_ptr(), link(), m_occurences, m_strValue, et size().

Voici le graphe d'appel pour cette fonction :

virtual C3D_API eVARIABLE_TYPE Castor3D::FrameVariable::GetType ( ) const

pure virtual

Implémenté dans Castor3D::OneFrameVariable< T >, Castor3D::MatrixFrameVariable< T, Rows, Columns >, et Castor3D::PointFrameVariable< T, Count >.

virtual C3D_API bool Castor3D::FrameVariable::Initialise ( )

pure virtual

Initialise la variable.

Renvoie: false if any problem occured

virtual void Castor3D::FrameVariable::link ( uint8_t * p_buffer )

pure virtual

Définit le buffer de cette variable.

Remarques: La variable perd la responsabilité de son buffer

Paramètres

[in] p_buffer Le buffer

Implémenté dans Castor3D::TFrameVariable< T >, et Castor3D::MatrixFrameVariable< T, Rows, Columns >.

Référencé par GetStrValue().

Voici le graphe des appelants de cette fonction :

C3D_API FrameVariable& Castor3D::FrameVariable::operator= ( FrameVariable 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

C3D_API FrameVariable& Castor3D::FrameVariable::operator= ( FrameVariable && 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

virtual void Castor3D::FrameVariable::SetName ( Castor::String const & p_name )

inlinevirtual

Définit le nom de la variable.

Paramètres

[in] p_name Le nom

Références m_name.

virtual C3D_API void Castor3D::FrameVariable::SetValueStr ( Castor::String const & p_value )

virtual

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

Paramètres

[in] p_value La chaîne contenant la valeur

virtual C3D_API void Castor3D::FrameVariable::SetValueStr	(	Castor::String const &	p_value,
		uint32_t	p_index
	)

virtual

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

Paramètres

[in]	p_index	L'index de la valeur
[in]	p_value	La chaîne contenant la valeur

virtual uint32_t Castor3D::FrameVariable::size ( ) const

pure virtual

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

Renvoie: La taille

Implémenté dans Castor3D::OneFrameVariable< T >, Castor3D::PointFrameVariable< T, Count >, et Castor3D::MatrixFrameVariable< T, Rows, Columns >.

Référencé par GetStrValue().

Voici le graphe des appelants de cette fonction :

virtual C3D_API void Castor3D::FrameVariable::Unbind ( )

pure virtual

Délie cette variable du shader.

Documentation des données membres

bool Castor3D::FrameVariable::m_changed

protected

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

Castor::String Castor3D::FrameVariable::m_name

protected

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

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

uint32_t Castor3D::FrameVariable::m_occurences

protected

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

Référencé par GetOccCount(), et GetStrValue().

ShaderProgram* Castor3D::FrameVariable::m_program

protected

Le programme parent.

Référencé par GetProgram().

Castor::StringArray Castor3D::FrameVariable::m_strValue

protected

La valeur de la variable.

Référencé par GetStrValue().

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

Y:/software/Castor3D/source/Core/Castor3D/Src/FrameVariable.hpp

Classes

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres