Référence de la classe Castor3D::Sampler

Définit un sampler pour une texture. Plus de détails...

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

Graphe de collaboration de Castor3D::Sampler:

Classes
class	BinaryParser
class	TextLoader
	Loader de Sampler. Plus de détails...

Fonctions membres publiques
C3D_API	Sampler (Engine &p_engine, Castor::String const &p_name=Castor::cuEmptyString)
	Constructeur. Plus de détails...
virtual C3D_API	~Sampler ()
	Destructeur. Plus de détails...
virtual C3D_API bool	Initialise ()=0
	Initialise le sampler. Plus de détails...
virtual C3D_API void	Cleanup ()=0
	Nettoie le sampler. Plus de détails...
virtual C3D_API bool	Bind (uint32_t p_index) const =0
	Applique le sampler. Plus de détails...
virtual C3D_API void	Unbind (uint32_t p_index) const =0
	Enlève le sampler. Plus de détails...
eINTERPOLATION_MODE	GetInterpolationMode (eINTERPOLATION_FILTER p_eFilter) const
	Récupère le mode d'interpolation pour le filtre donné Plus de détails...
void	SetInterpolationMode (eINTERPOLATION_FILTER p_eFilter, eINTERPOLATION_MODE p_mode)
	Définit le mode d'interpolation pour le filtre donné Plus de détails...
eWRAP_MODE	GetWrappingMode (eTEXTURE_UVW p_eUVW) const
	Récupère le mode de wrap pour la dimension donnée. Plus de détails...
void	SetWrappingMode (eTEXTURE_UVW p_eUVW, eWRAP_MODE p_mode)
	Définit le mode de wrap pour la dimension donnée. Plus de détails...
real	GetMaxAnisotropy () const
	Récupère la valeur maximale de filtrage anisotropique. Plus de détails...
void	SetMaxAnisotropy (real p_rValue)
	Définit la valeur maximale de filtrage anisotropique. Plus de détails...
real	GetMinLod () const
	Récupère le niveau minimal pour le LOD. Plus de détails...
void	SetMinLod (real p_rLod)
	Définit le niveau minimal pour le LOD. Plus de détails...
real	GetMaxLod () const
	Récupère le niveau maximal pour le LOD. Plus de détails...
void	SetMaxLod (real p_rLod)
	Définit le niveau maximal pour le LOD. Plus de détails...
real	GetLodBias () const
	Récupère le LOD bias. Plus de détails...
void	SetLodBias (real p_rLod)
	Définit le LOD bias. Plus de détails...
Castor::Colour const &	GetBorderColour () const
	Récupère la couleur de bord de la texture. Plus de détails...
void	SetBorderColour (Castor::Colour const &p_crColour)
	Définit la couleur de bord de la texture. Plus de détails...
Castor::String const &	GetName () const
	Récupère le nom de l'échantillonneur. Plus de détails...
void	SetName (Castor::String const &p_name)
	Récupère le nom de l'échantillonneur. Plus de détails...

Description détaillée

Définit un sampler pour une texture.

Auteur

Sylvain DOREMUS

Date

25/03/2013

Version

0.7.0

Documentation des constructeurs et destructeur

C3D_API Castor3D::Sampler::Sampler	(	Engine &	p_engine,
		Castor::String const &	p_name = Castor::cuEmptyString
	)

Constructeur.

Paramètres

[in]	p_name	Le nom du sampler
[in]	p_engine	Le moteur

virtual C3D_API Castor3D::Sampler::~Sampler ( )

virtual

Destructeur.

Documentation des fonctions membres

virtual C3D_API bool Castor3D::Sampler::Bind ( uint32_t  p_index ) const

pure virtual

Applique le sampler.

Paramètres

[in]

p_index

L'index du sampler

Renvoie

true si tout s'est bien passé

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

pure virtual

Nettoie le sampler.

Castor::Colour const& Castor3D::Sampler::GetBorderColour ( ) const

inline

Récupère la couleur de bord de la texture.

Renvoie

La couleur

eINTERPOLATION_MODE Castor3D::Sampler::GetInterpolationMode ( eINTERPOLATION_FILTER  p_eFilter ) const

inline

Récupère le mode d'interpolation pour le filtre donné

Paramètres

[in]

p_eFilter

Le filtre concerné

Renvoie

Le mode d'interpolation

real Castor3D::Sampler::GetLodBias ( ) const

inline

Récupère le LOD bias.

Renvoie

Le niveau

real Castor3D::Sampler::GetMaxAnisotropy ( ) const

inline

Récupère la valeur maximale de filtrage anisotropique.

Renvoie

La valeur

real Castor3D::Sampler::GetMaxLod ( ) const

inline

Récupère le niveau maximal pour le LOD.

Renvoie

Le niveau

real Castor3D::Sampler::GetMinLod ( ) const

inline

Récupère le niveau minimal pour le LOD.

Renvoie

Le niveau

Castor::String const& Castor3D::Sampler::GetName ( ) const

inline

Récupère le nom de l'échantillonneur.

Renvoie

Le nom

eWRAP_MODE Castor3D::Sampler::GetWrappingMode ( eTEXTURE_UVW  p_eUVW ) const

inline

Récupère le mode de wrap pour la dimension donnée.

Paramètres

[in]

p_eUVW

La dimension

Renvoie

Le mode de wrap

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

pure virtual

Initialise le sampler.

Renvoie

true si tout s'est bien passé

void Castor3D::Sampler::SetBorderColour ( Castor::Colour const &  p_crColour )

inline

Définit la couleur de bord de la texture.

Paramètres

[in]

p_crColour

La nouvelle valeur

void Castor3D::Sampler::SetInterpolationMode ( eINTERPOLATION_FILTER  p_eFilter, eINTERPOLATION_MODE  p_mode  )

inline

Définit le mode d'interpolation pour le filtre donné

Paramètres

[in]	p_eFilter	Le filtre concerné
[in]	p_mode	Le mode souhaité

void Castor3D::Sampler::SetLodBias ( real  p_rLod )

inline

Définit le LOD bias.

Paramètres

[in]

p_rLod

La nouvelle valeur

void Castor3D::Sampler::SetMaxAnisotropy ( real  p_rValue )

inline

Définit la valeur maximale de filtrage anisotropique.

Paramètres

[in]

p_rValue

La nouvelle valeur

void Castor3D::Sampler::SetMaxLod ( real  p_rLod )

inline

Définit le niveau maximal pour le LOD.

Paramètres

[in]

p_rLod

La nouvelle valeur

void Castor3D::Sampler::SetMinLod ( real  p_rLod )

inline

Définit le niveau minimal pour le LOD.

Paramètres

[in]

p_rLod

La nouvelle valeur

void Castor3D::Sampler::SetName ( Castor::String const &  p_name )

inline

Récupère le nom de l'échantillonneur.

Paramètres

[in]

p_name

Le nom

Références Castor3D::eINTERPOLATION_FILTER_COUNT.

void Castor3D::Sampler::SetWrappingMode ( eTEXTURE_UVW  p_eUVW, eWRAP_MODE  p_mode  )

inline

Définit le mode de wrap pour la dimension donnée.

Paramètres

[in]	p_eUVW	La dimension
[in]	p_mode	Le mode de wrap

virtual C3D_API void Castor3D::Sampler::Unbind ( uint32_t  p_index ) const

pure virtual

Enlève le sampler.

Paramètres

[in]

p_index

L'index du sampler

---

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

• Y:/software/Castor3D/source/Core/Castor3D/Src/Sampler.hpp