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
	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...

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

FrameVariable &	operator= (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 eFRAME_VARIABLE_TYPE	GetFullType () const =0

virtual eVARIABLE_TYPE	GetType () const =0

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

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_pBuffer)=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...

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

Attributs publics statiques
static const Castor::String	Names []
	Le nom des types de frame variable. Plus de détails...

Fonctions membres protégées
virtual void	DoSetValueStr (Castor::String const &p_strValue, uint32_t p_uiIndex)=0
	Définit la valeur de cette variable à partir d'une chaîne. Plus de détails...

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

ShaderProgramBase *	m_pProgram
	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

Castor3D::FrameVariable::FrameVariable ( ShaderProgramBase * p_pProgram )

Constructeur.

Castor3D::FrameVariable::FrameVariable	(	ShaderProgramBase *	p_pProgram,
		uint32_t	p_uiOcc
	)

Constructeur.

Paramètres

[in] p_uiOcc Les dimensions du tableau

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

Constructeur par copie.

Paramètres

[in] p_object L'objet à copier

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

Constructeur par déplacement.

Paramètres

[in] p_object L'objet à déplacer

virtual Castor3D::FrameVariable::~FrameVariable ( )

virtual

Destructeur.

Documentation des fonctions membres

virtual void Castor3D::FrameVariable::Apply ( )

pure virtual

Applique cette variable.

virtual void Castor3D::FrameVariable::Bind ( )

pure virtual

Active cette variable.

virtual 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 >.

virtual void Castor3D::FrameVariable::DoSetValueStr	(	Castor::String const &	p_strValue,
		uint32_t	p_uiIndex
	)

protectedpure virtual

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

Paramètres

[in]	p_uiIndex	L'index de la valeur
[in]	p_strValue	La chaîne contenant la valeur

virtual Castor::String Castor3D::FrameVariable::GetDataType ( ) const

pure virtual

Donne le type de données de la variable.

Renvoie: Le nom du type de données

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

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

pure virtual

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

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

inline

Récupère le nom de la variable.

Renvoie: Le nom

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

inline

Récupère le nombre d'occurences.

Renvoie: La valeur

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

inline

Récupère le programme parent.

Renvoie: La programme

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

inline

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

Renvoie: La valeur

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

inline

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

Paramètres

[in] p_uiIndex L'index

Renvoie: La valeur

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

pure virtual

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

virtual bool Castor3D::FrameVariable::Initialise ( )

pure virtual

Initialise la variable.

Renvoie: false if any problem occured

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

pure virtual

Définit le buffer de cette variable.

Remarques: La variable perd la responsabilité de son buffer

Paramètres

[in] p_pBuffer Le buffer

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

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

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_strName )

inlinevirtual

Définit le nom de la variable.

Paramètres

[in] p_strName Le nom

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

virtual

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

Paramètres

[in] p_strValue La chaîne contenant la valeur

virtual void Castor3D::FrameVariable::SetValueStr	(	Castor::String const &	p_strValue,
		uint32_t	p_uiIndex
	)

virtual

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

Paramètres

[in]	p_uiIndex	L'index de la valeur
[in]	p_strValue	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 >.

Documentation des données membres

bool Castor3D::FrameVariable::m_bChanged

protected

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

ShaderProgramBase* Castor3D::FrameVariable::m_pProgram

protected

Le programme parent.

Castor::String Castor3D::FrameVariable::m_strName

protected

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

Castor::StringArray Castor3D::FrameVariable::m_strValue

protected

La valeur de la variable.

uint32_t Castor3D::FrameVariable::m_uiOcc

protected

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

const Castor::String Castor3D::FrameVariable::Names[]

static

Le nom des types de frame variable.

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

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

Classes

Fonctions membres publiques

Attributs publics statiques

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