Castor3D  ..
Classes | Fonctions membres publiques | Liste de tous les membres
Référence de la classe Castor3D::Samplerabstract

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  TextWriter
 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 void 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...
 
InterpolationMode GetInterpolationMode (InterpolationFilter p_eFilter) const
 Récupère le mode d'interpolation pour le filtre donné Plus de détails...
 
void SetInterpolationMode (InterpolationFilter p_eFilter, InterpolationMode p_mode)
 Définit le mode d'interpolation pour le filtre donné Plus de détails...
 
WrapMode GetWrappingMode (TextureUVW p_eUVW) const
 Récupère le mode de wrap pour la dimension donnée. Plus de détails...
 
void SetWrappingMode (TextureUVW p_eUVW, WrapMode 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...
 
ComparisonMode GetComparisonMode () const
 
void SetComparisonMode (ComparisonMode p_mode)
 Définit le mode de comparaison. Plus de détails...
 
ComparisonFunc GetComparisonFunc () const
 
void SetComparisonFunc (ComparisonFunc p_mode)
 Définit la fonction de comparaison. 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

◆ Sampler()

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

Constructeur.

Paramètres
[in]p_nameLe nom du sampler
[in]p_engineLe moteur

◆ ~Sampler()

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

Destructeur.

Documentation des fonctions membres

◆ Bind()

virtual C3D_API void Castor3D::Sampler::Bind ( uint32_t  p_index) const
pure virtual

Applique le sampler.

Paramètres
[in]p_indexL'index du sampler

◆ Cleanup()

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

Nettoie le sampler.

◆ GetBorderColour()

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

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

Renvoie
La couleur

◆ GetComparisonFunc()

ComparisonFunc Castor3D::Sampler::GetComparisonFunc ( ) const
inline
Renvoie
La fonction de comparaison.

◆ GetComparisonMode()

ComparisonMode Castor3D::Sampler::GetComparisonMode ( ) const
inline
Renvoie
Le mode de comparaison.

◆ GetInterpolationMode()

InterpolationMode Castor3D::Sampler::GetInterpolationMode ( InterpolationFilter  p_eFilter) const
inline

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

Paramètres
[in]p_eFilterLe filtre concerné
Renvoie
Le mode d'interpolation

◆ GetLodBias()

real Castor3D::Sampler::GetLodBias ( ) const
inline

Récupère le LOD bias.

Renvoie
Le niveau

◆ GetMaxAnisotropy()

real Castor3D::Sampler::GetMaxAnisotropy ( ) const
inline

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

Renvoie
La valeur

◆ GetMaxLod()

real Castor3D::Sampler::GetMaxLod ( ) const
inline

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

Renvoie
Le niveau

◆ GetMinLod()

real Castor3D::Sampler::GetMinLod ( ) const
inline

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

Renvoie
Le niveau

◆ GetWrappingMode()

WrapMode Castor3D::Sampler::GetWrappingMode ( TextureUVW  p_eUVW) const
inline

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

Paramètres
[in]p_eUVWLa dimension
Renvoie
Le mode de wrap

◆ Initialise()

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

Initialise le sampler.

Renvoie
true si tout s'est bien passé

◆ SetBorderColour()

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

Définit la couleur de bord de la texture.

Paramètres
[in]p_crColourLa nouvelle valeur

◆ SetComparisonFunc()

void Castor3D::Sampler::SetComparisonFunc ( ComparisonFunc  p_mode)
inline

Définit la fonction de comparaison.

Paramètres
[in]p_modeLa fonction souhaitée.

Références Castor3D::eLEqual, Castor3D::eNearest, Castor3D::eNone, Castor3D::eRepeat, et Castor3D::eUndefined.

◆ SetComparisonMode()

void Castor3D::Sampler::SetComparisonMode ( ComparisonMode  p_mode)
inline

Définit le mode de comparaison.

Paramètres
[in]p_modeLe mode souhaité.

◆ SetInterpolationMode()

void Castor3D::Sampler::SetInterpolationMode ( InterpolationFilter  p_eFilter,
InterpolationMode  p_mode 
)
inline

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

Paramètres
[in]p_eFilterLe filtre concerné
[in]p_modeLe mode souhaité

◆ SetLodBias()

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

Définit le LOD bias.

Paramètres
[in]p_rLodLa nouvelle valeur

◆ SetMaxAnisotropy()

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

Définit la valeur maximale de filtrage anisotropique.

Paramètres
[in]p_rValueLa nouvelle valeur

◆ SetMaxLod()

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

Définit le niveau maximal pour le LOD.

Paramètres
[in]p_rLodLa nouvelle valeur

◆ SetMinLod()

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

Définit le niveau minimal pour le LOD.

Paramètres
[in]p_rLodLa nouvelle valeur

◆ SetWrappingMode()

void Castor3D::Sampler::SetWrappingMode ( TextureUVW  p_eUVW,
WrapMode  p_mode 
)
inline

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

Paramètres
[in]p_eUVWLa dimension
[in]p_modeLe mode de wrap

◆ Unbind()

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

Enlève le sampler.

Paramètres
[in]p_indexL'index du sampler

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