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

Représentation d'une unité de texture. Plus de détails...

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

Graphe de collaboration de Castor3D::TextureUnit:

Classes
class	TextWriter
	Loader de TextureUnit. Plus de détails...

Fonctions membres publiques
C3D_API	TextureUnit (Engine &p_engine)
	Constructeur. Plus de détails...
C3D_API	~TextureUnit ()
	Destructeur. Plus de détails...
C3D_API bool	Initialise ()
	Initialise la texture, id est : remplit le buffer d'image, cree la texture au niveau du renderer. Plus de détails...
C3D_API void	Cleanup ()
	Nettoie l'objet. Plus de détails...
C3D_API void	SetTexture (TextureLayoutSPtr p_texture)
	Definit la texture. Plus de détails...
C3D_API void	Bind () const
	Applique la texture. Plus de détails...
C3D_API void	Unbind () const
	Desactive la texture. Plus de détails...
C3D_API TextureType	GetType () const
	Récupère la dimension de la texture. Plus de détails...
C3D_API bool	IsTextureInitialised () const
	Récupère le statut d'initialisation de la texture. Plus de détails...
Castor3D::TextureLayoutSPtr	GetTexture () const
	Récupère la texture. Plus de détails...
Castor3D::AlphaBlendFunc	GetAlpFunction () const
	Récupère la fonction de mélange d'alpha. Plus de détails...
void	SetAlpFunction (Castor3D::AlphaBlendFunc p_func)
	Définit la fonction de mélange d'alpha. Plus de détails...
Castor3D::ColourBlendFunc	GetRgbFunction () const
	Récupère fonction de mélange RGB. Plus de détails...
void	SetRgbFunction (Castor3D::ColourBlendFunc p_func)
	Définit fonction de mélange RGB. Plus de détails...
Castor3D::ComparisonFunc	GetAlphaFunc () const
	Récupère la fonction d'alpha. Plus de détails...
void	SetAlphaFunc (Castor3D::ComparisonFunc p_func)
	Définit la fonction d'alpha. Plus de détails...
float	GetAlphaValue () const
	Récupère la valeur de référence pour l'alpha. Plus de détails...
void	SetAlphaValue (float p_fAlpha)
	Définit la valeur de référence pour l'alpha. Plus de détails...
Castor3D::TextureChannel	GetChannel () const
	Récupère le canal de la texture. Plus de détails...
void	SetChannel (Castor3D::TextureChannel p_channel)
	Définit le canal de la texture. Plus de détails...
uint32_t	GetIndex () const
	Récupère l'index de l'unité Plus de détails...
void	SetIndex (uint32_t p_index)
	Définit l'index de l'unité Plus de détails...
const Castor::Colour &	GetBlendColour () const
	Récupère la couleur de mélange. Plus de détails...
void	SetBlendColour (const Castor::Colour &p_clrBlend)
	Définit la couleur de mélange. Plus de détails...
void	SetRenderTarget (RenderTargetSPtr p_pTarget)
	Définit la cible contenant la texture. Plus de détails...
void	SetSampler (SamplerSPtr p_pSampler)
	Définit le sampler de la texture. Plus de détails...
SamplerSPtr	GetSampler () const
	Récupère le sampler de la texture. Plus de détails...
BlendSource	GetRgbArgument (BlendSrcIndex p_index) const
	Récupère le paramètre de mélange RGB. Plus de détails...
void	SetRgbArgument (BlendSrcIndex p_index, BlendSource p_value)
	Définit le paramètre de mélange RGB. Plus de détails...
BlendSource	GetAlpArgument (BlendSrcIndex p_index) const
	Récupère le paramètre de mélange Alpha. Plus de détails...
void	SetAlpArgument (BlendSrcIndex p_index, BlendSource p_value)
	Définit le paramètre de mélange Alpha. Plus de détails...
bool	IsTextured () const
	Dit si l'unité a une texture. Plus de détails...
void	SetAutoMipmaps (bool p_value)
	Définit le statut d'auto génération des mipmaps. Plus de détails...
bool	GetAutoMipmaps () const
	Récupère le statut d'auto génération des mipmaps. Plus de détails...
RenderTargetSPtr	GetRenderTarget () const
	Récupère la cible de rendu. Plus de détails...

Amis
class	TextureRenderer

Description détaillée

Représentation d'une unité de texture.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

Une unité de texture se compose d'une texture avec des options telles que son canal, modes de mélange, transformations.

Documentation des constructeurs et destructeur

TextureUnit()

C3D_API Castor3D::TextureUnit::TextureUnit ( Engine &  p_engine )

explicit

Constructeur.

Paramètres

p_engine

Le moteur

~TextureUnit()

C3D_API Castor3D::TextureUnit::~TextureUnit

(

)

Destructeur.

Documentation des fonctions membres

Bind()

C3D_API void Castor3D::TextureUnit::Bind

(

)

const

Applique la texture.

Cleanup()

C3D_API void Castor3D::TextureUnit::Cleanup

(

)

Nettoie l'objet.

GetAlpArgument()

BlendSource Castor3D::TextureUnit::GetAlpArgument ( BlendSrcIndex  p_index ) const

inline

Récupère le paramètre de mélange Alpha.

Paramètres

[in]

p_index

L'index du paramètre

Renvoie

La valeur

GetAlpFunction()

Castor3D::AlphaBlendFunc Castor3D::TextureUnit::GetAlpFunction ( ) const

inline

Récupère la fonction de mélange d'alpha.

Renvoie

La valeur

GetAlphaFunc()

Castor3D::ComparisonFunc Castor3D::TextureUnit::GetAlphaFunc ( ) const

inline

Récupère la fonction d'alpha.

Renvoie

La valeur

GetAlphaValue()

float Castor3D::TextureUnit::GetAlphaValue ( ) const

inline

Récupère la valeur de référence pour l'alpha.

Renvoie

La valeur

GetAutoMipmaps()

bool Castor3D::TextureUnit::GetAutoMipmaps ( ) const

inline

Récupère le statut d'auto génération des mipmaps.

Renvoie

La valeur

GetBlendColour()

const Castor::Colour& Castor3D::TextureUnit::GetBlendColour ( ) const

inline

Récupère la couleur de mélange.

Renvoie

La valeur

GetChannel()

Castor3D::TextureChannel Castor3D::TextureUnit::GetChannel ( ) const

inline

Récupère le canal de la texture.

Renvoie

La valeur

GetIndex()

uint32_t Castor3D::TextureUnit::GetIndex ( ) const

inline

Récupère l'index de l'unité

Renvoie

La valeur

GetRenderTarget()

RenderTargetSPtr Castor3D::TextureUnit::GetRenderTarget ( ) const

inline

Récupère la cible de rendu.

Renvoie

La valeur

GetRgbArgument()

BlendSource Castor3D::TextureUnit::GetRgbArgument ( BlendSrcIndex  p_index ) const

inline

Récupère le paramètre de mélange RGB.

Paramètres

[in]

p_index

L'index du paramètre

Renvoie

La valeur

GetRgbFunction()

Castor3D::ColourBlendFunc Castor3D::TextureUnit::GetRgbFunction ( ) const

inline

Récupère fonction de mélange RGB.

Renvoie

La valeur

GetSampler()

SamplerSPtr Castor3D::TextureUnit::GetSampler ( ) const

inline

Récupère le sampler de la texture.

Renvoie

Le buffer

GetTexture()

Castor3D::TextureLayoutSPtr Castor3D::TextureUnit::GetTexture ( ) const

inline

Récupère la texture.

Renvoie

La valeur

GetType()

C3D_API TextureType Castor3D::TextureUnit::GetType

(

)

const

Récupère la dimension de la texture.

Renvoie

La dimension de la texture

Initialise()

C3D_API bool Castor3D::TextureUnit::Initialise

(

)

Initialise la texture, id est : remplit le buffer d'image, cree la texture au niveau du renderer.

IsTextured()

bool Castor3D::TextureUnit::IsTextured ( ) const

inline

Dit si l'unité a une texture.

Renvoie

false si la texture est nulle

IsTextureInitialised()

C3D_API bool Castor3D::TextureUnit::IsTextureInitialised

(

)

const

Récupère le statut d'initialisation de la texture.

Renvoie

false si la texture est nulle ou non initialisée

SetAlpArgument()

void Castor3D::TextureUnit::SetAlpArgument ( BlendSrcIndex  p_index, BlendSource  p_value  )

inline

Définit le paramètre de mélange Alpha.

Paramètres

[in]	p_index	L'index du paramètre
[in]	p_value	La nouvelle valeur

SetAlpFunction()

void Castor3D::TextureUnit::SetAlpFunction ( Castor3D::AlphaBlendFunc  p_func )

inline

Définit la fonction de mélange d'alpha.

Paramètres

[in]

p_func

La nouvelle valeur

SetAlphaFunc()

void Castor3D::TextureUnit::SetAlphaFunc ( Castor3D::ComparisonFunc  p_func )

inline

Définit la fonction d'alpha.

Paramètres

[in]

p_func

La nouvelle valeur

SetAlphaValue()

void Castor3D::TextureUnit::SetAlphaValue ( float  p_fAlpha )

inline

Définit la valeur de référence pour l'alpha.

Paramètres

[in]

p_fAlpha

La nouvelle valeur

SetAutoMipmaps()

void Castor3D::TextureUnit::SetAutoMipmaps ( bool  p_value )

inline

Définit le statut d'auto génération des mipmaps.

Paramètres

[in]

p_value

La nouvelle valeur

SetBlendColour()

void Castor3D::TextureUnit::SetBlendColour ( const Castor::Colour &  p_clrBlend )

inline

Définit la couleur de mélange.

Paramètres

[in]

p_clrBlend

La nouvelle valeur

SetChannel()

void Castor3D::TextureUnit::SetChannel ( Castor3D::TextureChannel  p_channel )

inline

Définit le canal de la texture.

Paramètres

[in]

p_channel

La nouvelle valeur

SetIndex()

void Castor3D::TextureUnit::SetIndex ( uint32_t  p_index )

inline

Définit l'index de l'unité

Paramètres

[in]

p_index

La nouvelle valeur

SetRenderTarget()

void Castor3D::TextureUnit::SetRenderTarget ( RenderTargetSPtr  p_pTarget )

inline

Définit la cible contenant la texture.

Paramètres

[in]

p_pTarget

La nouvelle valeur

SetRgbArgument()

void Castor3D::TextureUnit::SetRgbArgument ( BlendSrcIndex  p_index, BlendSource  p_value  )

inline

Définit le paramètre de mélange RGB.

Paramètres

[in]	p_index	L'index du paramètre
[in]	p_value	La nouvelle valeur

SetRgbFunction()

void Castor3D::TextureUnit::SetRgbFunction ( Castor3D::ColourBlendFunc  p_func )

inline

Définit fonction de mélange RGB.

Paramètres

[in]

p_func

La nouvelle valeur

SetSampler()

void Castor3D::TextureUnit::SetSampler ( SamplerSPtr  p_pSampler )

inline

Définit le sampler de la texture.

Paramètres

[in]

p_pSampler

Le sampler

SetTexture()

C3D_API void Castor3D::TextureUnit::SetTexture

(

TextureLayoutSPtr

p_texture

)

Definit la texture.

Paramètres

[in]

p_texture

La texture

Unbind()

C3D_API void Castor3D::TextureUnit::Unbind

(

)

const

Desactive la texture.

Documentation des fonctions amies et associées

TextureRenderer

friend class TextureRenderer

friend

---

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

• Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Texture/TextureUnit.hpp