Référence de la classe castor3d::Uniform

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	constPtr () 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 )

explicit

Constructeur.

Paramètres

[in]

p_occurences

Les dimensions du tableau.

~Uniform()

virtual C3D_API castor3d::Uniform::~Uniform ( )

virtual

Destructeur.

Documentation des fonctions membres

constPtr()

virtual C3D_API uint8_t const* const castor3d::Uniform::constPtr ( ) 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_index

L'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_buffer	Le tampon.
[in]	p_stride	La 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_value

La 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_name

Le 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_value	La chaîne.
[in]	p_index	L'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_value

La 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 :

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Shader/Uniform/Uniform.hpp