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	BinaryParser
	Loader de TextureUnit. Plus de détails...

class	TextLoader
	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 void	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 (TextureSPtr 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 void	UploadImage (bool p_bSync)
	Charge l'image courante sur le GPU. Plus de détails...

C3D_API void	DownloadImage (bool p_bSync)
	Charge l'image courante à partir du GPU. Plus de détails...

C3D_API bool	LoadTexture (Castor::Path const &p_pathFile)
	Charge l'image de la texture à partir du chemin donné Plus de détails...

C3D_API eTEXTURE_TYPE	GetType () const
	Récupère la dimension de la texture. Plus de détails...

C3D_API eTEXTURE_MAP_MODE	GetMappingMode () const
	Récupère le mode mappage de la texture. Plus de détails...

C3D_API void	SetMappingMode (eTEXTURE_MAP_MODE p_mode)
	Définit le mode de mappage de la texture. Plus de détails...

C3D_API uint8_t const *	GetImageBuffer () const
	Récupère le buffer de l'image de la texture. Plus de détails...

C3D_API uint8_t *	GetImageBuffer ()
	Récupère le buffer de l'image de la texture. Plus de détails...

C3D_API Castor::PxBufferBaseSPtr const	GetImagePixels () const
	Récupère les pixels de l'image de la texture. Plus de détails...

C3D_API Castor::PxBufferBaseSPtr	GetImagePixels ()
	Récupère les pixels de l'image de la texture. Plus de détails...

C3D_API uint32_t	GetImageSize () const
	Récupère la taille de l'image de la texture (en octets) Plus de détails...

C3D_API uint32_t	GetWidth () const
	Récupère la largeur de l'image de la texture. Plus de détails...

C3D_API uint32_t	GetHeight () const
	Récupère la hauteur de l'image de la texture. Plus de détails...

C3D_API Castor::ePIXEL_FORMAT	GetPixelFormat () const
	Récupère le format des pixels de l'image 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...

const Castor::Path &	GetTexturePath () const
	Récupère le chemin du fichier de la texture. Plus de détails...

Castor3D::TextureSPtr	GetTexture () const
	Récupère la texture. Plus de détails...

Castor3D::eALPHA_BLEND_FUNC	GetAlpFunction () const
	Récupère la fonction de mélange d'alpha. Plus de détails...

void	SetAlpFunction (Castor3D::eALPHA_BLEND_FUNC p_func)
	Définit la fonction de mélange d'alpha. Plus de détails...

Castor3D::eRGB_BLEND_FUNC	GetRgbFunction () const
	Récupère fonction de mélange RGB. Plus de détails...

void	SetRgbFunction (Castor3D::eRGB_BLEND_FUNC p_func)
	Définit fonction de mélange RGB. Plus de détails...

Castor3D::eALPHA_FUNC	GetAlphaFunc () const
	Récupère la fonction d'alpha. Plus de détails...

void	SetAlphaFunc (Castor3D::eALPHA_FUNC 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::eTEXTURE_CHANNEL	GetChannel () const
	Récupère le canal de la texture. Plus de détails...

void	SetChannel (Castor3D::eTEXTURE_CHANNEL 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...

eBLEND_SOURCE	GetRgbArgument (eBLEND_SRC_INDEX p_index) const
	Récupère le paramètre de mélange RGB. Plus de détails...

void	SetRgbArgument (eBLEND_SRC_INDEX p_index, eBLEND_SOURCE p_value)
	Définit le paramètre de mélange RGB. Plus de détails...

eBLEND_SOURCE	GetAlpArgument (eBLEND_SRC_INDEX p_index) const
	Récupère le paramètre de mélange Alpha. Plus de détails...

void	SetAlpArgument (eBLEND_SRC_INDEX p_index, eBLEND_SOURCE 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

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

Constructeur.

Paramètres

p_engine Le moteur

C3D_API Castor3D::TextureUnit::~TextureUnit ( )

Destructeur.

Documentation des fonctions membres

C3D_API void Castor3D::TextureUnit::Bind ( ) const

Applique la texture.

C3D_API void Castor3D::TextureUnit::Cleanup ( )

Nettoie l'objet.

C3D_API void Castor3D::TextureUnit::DownloadImage ( bool p_bSync )

Charge l'image courante à partir du GPU.

Paramètres

[in] p_bSync Dit si le chargement doit être synchrone ou pas

eBLEND_SOURCE Castor3D::TextureUnit::GetAlpArgument ( eBLEND_SRC_INDEX 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

Castor3D::eALPHA_BLEND_FUNC Castor3D::TextureUnit::GetAlpFunction ( ) const

inline

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

Renvoie: La valeur

Castor3D::eALPHA_FUNC Castor3D::TextureUnit::GetAlphaFunc ( ) const

inline

Récupère la fonction d'alpha.

Renvoie: La valeur

float Castor3D::TextureUnit::GetAlphaValue ( ) const

inline

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

Renvoie: La valeur

bool Castor3D::TextureUnit::GetAutoMipmaps ( ) const

inline

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

Renvoie: La valeur

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

inline

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

Renvoie: La valeur

Castor3D::eTEXTURE_CHANNEL Castor3D::TextureUnit::GetChannel ( ) const

inline

Récupère le canal de la texture.

Renvoie: La valeur

C3D_API uint32_t Castor3D::TextureUnit::GetHeight ( ) const

Récupère la hauteur de l'image de la texture.

Renvoie: La hauteur

C3D_API uint8_t const* Castor3D::TextureUnit::GetImageBuffer ( ) const

Récupère le buffer de l'image de la texture.

Renvoie: Le buffer

C3D_API uint8_t* Castor3D::TextureUnit::GetImageBuffer ( )

Récupère le buffer de l'image de la texture.

Renvoie: Le buffer

C3D_API Castor::PxBufferBaseSPtr const Castor3D::TextureUnit::GetImagePixels ( ) const

Récupère les pixels de l'image de la texture.

Renvoie: Les pixels

C3D_API Castor::PxBufferBaseSPtr Castor3D::TextureUnit::GetImagePixels ( )

Récupère les pixels de l'image de la texture.

Renvoie: Les pixels

C3D_API uint32_t Castor3D::TextureUnit::GetImageSize ( ) const

Récupère la taille de l'image de la texture (en octets)

Renvoie: La taille

uint32_t Castor3D::TextureUnit::GetIndex ( ) const

inline

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

Renvoie: La valeur

C3D_API eTEXTURE_MAP_MODE Castor3D::TextureUnit::GetMappingMode ( ) const

Récupère le mode mappage de la texture.

Renvoie: Le mode mappage de la texture

C3D_API Castor::ePIXEL_FORMAT Castor3D::TextureUnit::GetPixelFormat ( ) const

Récupère le format des pixels de l'image de la texture.

Renvoie: Le format des pixels

RenderTargetSPtr Castor3D::TextureUnit::GetRenderTarget ( ) const

inline

Récupère la cible de rendu.

Renvoie: La valeur

eBLEND_SOURCE Castor3D::TextureUnit::GetRgbArgument ( eBLEND_SRC_INDEX 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

Castor3D::eRGB_BLEND_FUNC Castor3D::TextureUnit::GetRgbFunction ( ) const

inline

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

Renvoie: La valeur

SamplerSPtr Castor3D::TextureUnit::GetSampler ( ) const

inline

Récupère le sampler de la texture.

Renvoie: Le buffer

Castor3D::TextureSPtr Castor3D::TextureUnit::GetTexture ( ) const

inline

Récupère la texture.

Renvoie: La valeur

const Castor::Path& Castor3D::TextureUnit::GetTexturePath ( ) const

inline

Récupère le chemin du fichier de la texture.

Renvoie: La valeur

C3D_API eTEXTURE_TYPE Castor3D::TextureUnit::GetType ( ) const

Récupère la dimension de la texture.

Renvoie: La dimension de la texture

C3D_API uint32_t Castor3D::TextureUnit::GetWidth ( ) const

Récupère la largeur de l'image de la texture.

Renvoie: La largeur

C3D_API void Castor3D::TextureUnit::Initialise ( )

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

bool Castor3D::TextureUnit::IsTextured ( ) const

inline

Dit si l'unité a une texture.

Renvoie: false si la texture est nulle

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

C3D_API bool Castor3D::TextureUnit::LoadTexture ( Castor::Path const & p_pathFile )

Charge l'image de la texture à partir du chemin donné

Paramètres

[in] p_pathFile Le chemin du fichier image

Renvoie: false si un problème quelconque est arrivé

void Castor3D::TextureUnit::SetAlpArgument	(	eBLEND_SRC_INDEX	p_index,
		eBLEND_SOURCE	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

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

inline

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

Paramètres

[in] p_func La nouvelle valeur

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

inline

Définit la fonction d'alpha.

Paramètres

[in] p_func La nouvelle valeur

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

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

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

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

inline

Définit le canal de la texture.

Paramètres

[in] p_channel La nouvelle valeur

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

inline

Définit l'index de l'unité

Paramètres

[in] p_index La nouvelle valeur

C3D_API void Castor3D::TextureUnit::SetMappingMode ( eTEXTURE_MAP_MODE p_mode )

Définit le mode de mappage de la texture.

Paramètres

[in] p_mode Le mode de mappage de la texture

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

inline

Définit la cible contenant la texture.

Paramètres

[in] p_pTarget La nouvelle valeur

void Castor3D::TextureUnit::SetRgbArgument	(	eBLEND_SRC_INDEX	p_index,
		eBLEND_SOURCE	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

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

inline

Définit fonction de mélange RGB.

Paramètres

[in] p_func La nouvelle valeur

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

inline

Définit le sampler de la texture.

Paramètres

[in] p_pSampler Le sampler

C3D_API void Castor3D::TextureUnit::SetTexture ( TextureSPtr p_texture )

Definit la texture.

Paramètres

[in] p_texture La texture

C3D_API void Castor3D::TextureUnit::Unbind ( ) const

Desactive la texture.

C3D_API void Castor3D::TextureUnit::UploadImage ( bool p_bSync )

Charge l'image courante sur le GPU.

Paramètres

[in] p_bSync Dit si le chargement doit être synchrone ou pas

Documentation des fonctions amies et associées

friend class TextureRenderer

friend

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

Y:/software/Castor3D/source/Core/Castor3D/Src/TextureUnit.hpp

Classes

Fonctions membres publiques

Amis

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des fonctions amies et associées