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 &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::RgbaColour const &	getBorderColour () const
	Récupère la couleur de bord de la texture. Plus de détails...

void	setBorderColour (castor::RgbaColour 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 &	engine,
		castor::String const &	p_name = `castor::cuEmptyString`
	)

Constructeur.

Paramètres

[in]	p_name	Le nom du sampler
[in]	engine	Le 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_index L'index du sampler

◆ cleanup()

virtual C3D_API void castor3d::Sampler::cleanup ( )

pure virtual

Nettoie le sampler.

◆ getBorderColour()

castor::RgbaColour 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_eFilter Le 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_eUVW La 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::RgbaColour const & p_crColour )

inline

Définit la couleur de bord de la texture.

Paramètres

[in] p_crColour La nouvelle valeur

◆ setComparisonFunc()

void castor3d::Sampler::setComparisonFunc ( ComparisonFunc p_mode )

inline

Définit la fonction de comparaison.

Paramètres

[in] p_mode La 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_mode Le 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_eFilter	Le filtre concerné
[in]	p_mode	Le mode souhaité

◆ setLodBias()

void castor3d::Sampler::setLodBias ( real p_rLod )

inline

Définit le LOD bias.

Paramètres

[in] p_rLod La nouvelle valeur

◆ setMaxAnisotropy()

void castor3d::Sampler::setMaxAnisotropy ( real p_rValue )

inline

Définit la valeur maximale de filtrage anisotropique.

Paramètres

[in] p_rValue La nouvelle valeur

◆ setMaxLod()

void castor3d::Sampler::setMaxLod ( real p_rLod )

inline

Définit le niveau maximal pour le LOD.

Paramètres

[in] p_rLod La nouvelle valeur

◆ setMinLod()

void castor3d::Sampler::setMinLod ( real p_rLod )

inline

Définit le niveau minimal pour le LOD.

Paramètres

[in] p_rLod La 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_eUVW	La dimension
[in]	p_mode	Le 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_index L'index du sampler

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

Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Texture/Sampler.hpp

Classes

Fonctions membres publiques

Description détaillée

Documentation des constructeurs et destructeur

◆ Sampler()

◆ ~Sampler()

Documentation des fonctions membres

◆ bind()

◆ cleanup()

◆ getBorderColour()

◆ getComparisonFunc()

◆ getComparisonMode()

◆ getInterpolationMode()

◆ getLodBias()

◆ getMaxAnisotropy()

◆ getMaxLod()

◆ getMinLod()

◆ getWrappingMode()

◆ initialise()

◆ setBorderColour()

◆ setComparisonFunc()

◆ setComparisonMode()

◆ setInterpolationMode()

◆ setLodBias()

◆ setMaxAnisotropy()

◆ setMaxLod()

◆ setMinLod()

◆ setWrappingMode()

◆ unbind()