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

Class de base d'une texture. Plus de détails...

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

Graphe de collaboration de Castor3D::TextureBase:

Fonctions membres publiques
	TextureBase (eTEXTURE_TYPE p_eType, RenderSystem *p_pRenderSystem)
	Constructeur. Plus de détails...
virtual	~TextureBase ()
	Destructeur. Plus de détails...
virtual bool	Create ()=0
	Fonction de création. Plus de détails...
virtual void	Destroy ()=0
	Fonction de destruction. Plus de détails...
virtual bool	Initialise (uint32_t p_uiIndex)=0
	Fonction d'initialisation. Plus de détails...
virtual void	Cleanup ()=0
	Fonction de nettoyage. Plus de détails...
virtual uint8_t *	Lock (uint32_t p_uiLock)=0
	Locke le buffer de l'image à partir du GPU, permettant des modification dessus. Plus de détails...
virtual void	Unlock (bool p_bModified)=0
	Délocke le buffer de l'image à partir du GPU. Plus de détails...
virtual bool	Bind ()=0
	Fonction d'activation, pour dire au GPU qu'il est activé Plus de détails...
virtual void	Unbind ()=0
	Fonction de désactivation, pour dire au GPU qu'il est désactivé Plus de détails...
virtual void	GenerateMipmaps ()=0
	Génère les mipmaps de la texture. Plus de détails...
bool	IsInitialised () const
	Récupère le statut d'initialisation. Plus de détails...
eTEXTURE_TYPE	GetType () const
	Récupère le type de texture. Plus de détails...
eTEXTURE_DIMENSION	GetDimension () const
	Récupère la dimension de la texture. Plus de détails...
void	SetDimension (eTEXTURE_DIMENSION p_eDimension)
	Définit la dimension de la texture. Plus de détails...
eTEXTURE_MAP_MODE	GetMappingMode () const
	Récupère le mode mappage de la texture. Plus de détails...
void	SetMappingMode (eTEXTURE_MAP_MODE p_eMapMode)
	Définit le mode mappage de la texture. Plus de détails...
Castor::Size	GetDimensions () const
	Récupère les dimensions de l'image de la texture. Plus de détails...
uint32_t	GetDepth () const
	Récupère la profondeur de la texture. Plus de détails...
Castor::ePIXEL_FORMAT	GetPixelFormat () const
	Récupère le format des pixels de la texture. Plus de détails...
uint32_t	GetWidth () const
	Récupère la largeur de l'image de la texture. Plus de détails...
uint32_t	GetHeight () const
	Récupère la hauteur de l'image de la texture. Plus de détails...
void	SetImage (Castor::PxBufferBaseSPtr p_pBuffer)
	Définit le buffer de la texture. Plus de détails...
Castor::PxBufferBaseSPtr	GetBuffer () const
	Récupère le buffer de la texture. Plus de détails...
uint32_t const &	GetIndex () const
	Récupère l'index de 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...

Fonctions membres protégées
virtual bool	DoInitialise ()=0
	Initialisation spécifique selon l'API. Plus de détails...
virtual bool	DoBind ()=0
	Activation spécifique selon l'API. Plus de détails...
virtual void	DoUnbind ()=0
	Désactivation spécifique selon l'API. Plus de détails...
	DECLARE_VECTOR (Castor::PxBufferBaseSPtr, PxBuffer)

Attributs protégés
bool	m_bInitialised
	Statut d'initialisation. Plus de détails...
eTEXTURE_TYPE	m_eType
	Type de texture. Plus de détails...
eTEXTURE_DIMENSION	m_eDimension
	Compte des dimensions de la texture. Plus de détails...
eTEXTURE_MAP_MODE	m_eMapMode
	Modes de mappage de la texture. Plus de détails...
uint32_t	m_uiIndex
	Index de la texture. Plus de détails...
uint32_t	m_uiDepth
	Profondeur de la texture 3D. Plus de détails...
Castor::PxBufferBaseSPtr	m_pPixelBuffer
	Pixels de la texture, au moins au moment de l'initialisation. Plus de détails...
SamplerWPtr	m_pSampler
	Sampler de la texture. Plus de détails...
Castor::ePIXEL_FORMAT	m_ePixelFormat
	Le format du buffer de pixels. Plus de détails...
Castor::Size	m_size
	Les dimensions du buffer de pixels. Plus de détails...
RenderSystem *	m_pRenderSystem
	Le render system. Plus de détails...

Description détaillée

Class de base d'une texture.

Auteur

Sylvain DOREMUS

Date

14/02/2010

Documentation des constructeurs et destructeur

Castor3D::TextureBase::TextureBase	(	eTEXTURE_TYPE	p_eType,
		RenderSystem *	p_pRenderSystem
	)

Constructeur.

Paramètres

[in]	p_eType	Le type de texture
[in]	p_pRenderSystem	Le render system

virtual Castor3D::TextureBase::~TextureBase ( )

virtual

Destructeur.

Documentation des fonctions membres

virtual bool Castor3D::TextureBase::Bind ( )

pure virtual

Fonction d'activation, pour dire au GPU qu'il est activé

Paramètres

[in]

p_uiIndex

L'index de texture

Renvoie

true si tout s'est bien passé

Implémenté dans Castor3D::StaticTexture, et Castor3D::DynamicTexture.

virtual void Castor3D::TextureBase::Cleanup ( )

pure virtual

Fonction de nettoyage.

Implémenté dans Castor3D::StaticTexture, et Castor3D::DynamicTexture.

virtual bool Castor3D::TextureBase::Create ( )

pure virtual

Fonction de création.

Renvoie

true si tout s'est bien passé

Castor3D::TextureBase::DECLARE_VECTOR ( Castor::PxBufferBaseSPtr  , PxBuffer    )

protected

virtual void Castor3D::TextureBase::Destroy ( )

pure virtual

Fonction de destruction.

virtual bool Castor3D::TextureBase::DoBind ( )

protectedpure virtual

Activation spécifique selon l'API.

Renvoie

si tout s'est bien passé

virtual bool Castor3D::TextureBase::DoInitialise ( )

protectedpure virtual

Initialisation spécifique selon l'API.

Renvoie

si tout s'est bien passé

virtual void Castor3D::TextureBase::DoUnbind ( )

protectedpure virtual

Désactivation spécifique selon l'API.

virtual void Castor3D::TextureBase::GenerateMipmaps ( )

pure virtual

Génère les mipmaps de la texture.

Castor::PxBufferBaseSPtr Castor3D::TextureBase::GetBuffer ( ) const

inline

Récupère le buffer de la texture.

Renvoie

Le buffer

uint32_t Castor3D::TextureBase::GetDepth ( ) const

inline

Récupère la profondeur de la texture.

Renvoie

La profondeur, 1 si pas 3D

eTEXTURE_DIMENSION Castor3D::TextureBase::GetDimension ( ) const

inline

Récupère la dimension de la texture.

Renvoie

La dimension de la texture

Castor::Size Castor3D::TextureBase::GetDimensions ( ) const

inline

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

Renvoie

Les dimensions de l'image

uint32_t Castor3D::TextureBase::GetHeight ( ) const

inline

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

Renvoie

La hauteur

uint32_t const& Castor3D::TextureBase::GetIndex ( ) const

inline

Récupère l'index de la texture.

Renvoie

L'index

eTEXTURE_MAP_MODE Castor3D::TextureBase::GetMappingMode ( ) const

inline

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

Renvoie

Le mode mappage de la texture

Castor::ePIXEL_FORMAT Castor3D::TextureBase::GetPixelFormat ( ) const

inline

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

Renvoie

Le format des pixels

SamplerSPtr Castor3D::TextureBase::GetSampler ( ) const

inline

Récupère le sampler de la texture.

Renvoie

Le buffer

eTEXTURE_TYPE Castor3D::TextureBase::GetType ( ) const

inline

Récupère le type de texture.

Renvoie

Le type de texture

uint32_t Castor3D::TextureBase::GetWidth ( ) const

inline

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

Renvoie

La largeur

virtual bool Castor3D::TextureBase::Initialise ( uint32_t  p_uiIndex )

pure virtual

Fonction d'initialisation.

Paramètres

[in]

p_uiIndex

L'index de la texture

Renvoie

true si tout s'est bien passé

Implémenté dans Castor3D::DynamicTexture, et Castor3D::StaticTexture.

bool Castor3D::TextureBase::IsInitialised ( ) const

inline

Récupère le statut d'initialisation.

Renvoie

Le statut d'initialisation

virtual uint8_t* Castor3D::TextureBase::Lock ( uint32_t  p_uiLock )

pure virtual

Locke le buffer de l'image à partir du GPU, permettant des modification dessus.

Paramètres

[in]

p_eLock

Définit le mode de lock (lecture, écriture, les 2), combinaison de eLOCK_FLAG

Renvoie

Le buffer de l'image

void Castor3D::TextureBase::SetDimension ( eTEXTURE_DIMENSION  p_eDimension )

inline

Définit la dimension de la texture.

Paramètres

[in]

p_eDimension

La dimension de la texture

void Castor3D::TextureBase::SetImage

(

Castor::PxBufferBaseSPtr

p_pBuffer

)

Définit le buffer de la texture.

Paramètres

[in]

p_pBuffer

Le buffer

void Castor3D::TextureBase::SetMappingMode ( eTEXTURE_MAP_MODE  p_eMapMode )

inline

Définit le mode mappage de la texture.

Paramètres

[in]

p_eMapMode

Le mode mappage de la texture

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

inline

Définit le sampler de la texture.

Paramètres

[in]

p_pSampler

Le sampler

virtual void Castor3D::TextureBase::Unbind ( )

pure virtual

Fonction de désactivation, pour dire au GPU qu'il est désactivé

Paramètres

[in]

p_uiIndex

L'index de texture

Implémenté dans Castor3D::StaticTexture, et Castor3D::DynamicTexture.

virtual void Castor3D::TextureBase::Unlock ( bool  p_bModified )

pure virtual

Délocke le buffer de l'image à partir du GPU.

Paramètres

[in]

p_bModified

Dit si le buffer a été modifié, afin que les modifications soient mises sur le GPU

Documentation des données membres

bool Castor3D::TextureBase::m_bInitialised

protected

Statut d'initialisation.

eTEXTURE_DIMENSION Castor3D::TextureBase::m_eDimension

protected

Compte des dimensions de la texture.

eTEXTURE_MAP_MODE Castor3D::TextureBase::m_eMapMode

protected

Modes de mappage de la texture.

Castor::ePIXEL_FORMAT Castor3D::TextureBase::m_ePixelFormat

protected

Le format du buffer de pixels.

eTEXTURE_TYPE Castor3D::TextureBase::m_eType

protected

Type de texture.

Castor::PxBufferBaseSPtr Castor3D::TextureBase::m_pPixelBuffer

protected

Pixels de la texture, au moins au moment de l'initialisation.

RenderSystem* Castor3D::TextureBase::m_pRenderSystem

protected

Le render system.

SamplerWPtr Castor3D::TextureBase::m_pSampler

protected

Sampler de la texture.

Castor::Size Castor3D::TextureBase::m_size

protected

Les dimensions du buffer de pixels.

uint32_t Castor3D::TextureBase::m_uiDepth

protected

Profondeur de la texture 3D.

uint32_t Castor3D::TextureBase::m_uiIndex

protected

Index de la texture.

---

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

• Y:/projets/Castor3D/source/Core/Castor3D/Src/Texture.hpp