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

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

Graphe de collaboration de Castor3D::Texture:

Fonctions membres publiques
C3D_API	Texture (eTEXTURE_BASE_TYPE p_type, RenderSystem &p_renderSystem, uint8_t p_cpuAccess, uint8_t p_gpuAccess)
	Constructeur. Plus de détails...

virtual C3D_API	~Texture ()
	Destructeur. Plus de détails...

C3D_API void	SetImage (Castor::PxBufferBaseSPtr p_buffer)
	Définit le buffer de la texture. Plus de détails...

C3D_API bool	Bind (uint32_t p_index) const
	Fonction d'activation, pour dire au GPU qu'il est activé Plus de détails...

C3D_API void	Unbind (uint32_t p_index) const
	Fonction de désactivation, pour dire au GPU qu'il est désactivé Plus de détails...

virtual C3D_API bool	Create ()=0
	Fonction de création. Plus de détails...

virtual C3D_API void	Destroy ()=0
	Fonction de destruction. Plus de détails...

virtual C3D_API bool	Initialise ()=0
	Fonction d'initialisation. Plus de détails...

virtual C3D_API void	Cleanup ()=0
	Fonction de nettoyage. Plus de détails...

virtual C3D_API uint8_t *	Lock (uint32_t p_lock)=0
	Locke le buffer de l'image à partir du GPU, permettant des modification dessus. Plus de détails...

virtual C3D_API void	Unlock (bool p_modified)=0
	Délocke le buffer de l'image à partir du GPU. Plus de détails...

virtual C3D_API void	GenerateMipmaps () const =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_BASE_TYPE	GetBaseType () const
	Récupère le type de texture. Plus de détails...

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

void	SetType (eTEXTURE_TYPE p_dimension)
	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...

Castor::PxBufferBaseSPtr	GetBuffer () const
	Récupère le buffer de la texture. Plus de détails...

Fonctions membres protégées
virtual C3D_API bool	DoInitialise ()=0
	Initialisation spécifique selon l'API. Plus de détails...

virtual C3D_API bool	DoBind (uint32_t p_index) const =0
	Activation spécifique selon l'API. Plus de détails...

virtual C3D_API void	DoUnbind (uint32_t p_index) const =0
	Désactivation spécifique selon l'API. Plus de détails...

	DECLARE_VECTOR (Castor::PxBufferBaseSPtr, PxBuffer)

Attributs protégés
bool	m_initialised
	Statut d'initialisation. Plus de détails...

eTEXTURE_BASE_TYPE	m_baseType
	La type de base de la texture. Plus de détails...

eTEXTURE_TYPE	m_type
	Type de texture. Plus de détails...

eTEXTURE_MAP_MODE	m_mapMode
	Modes de mappage de la texture. Plus de détails...

uint32_t	m_depth
	Profondeur de la texture 3D. Plus de détails...

Castor::PxBufferBaseSPtr	m_pixelBuffer
	Pixels de la texture, au moins au moment de l'initialisation. Plus de détails...

Castor::ePIXEL_FORMAT	m_pixelFormat
	Le format du buffer de pixels. Plus de détails...

Castor::Size	m_size
	Les dimensions du buffer de pixels. Plus de détails...

uint8_t	m_cpuAccess
	Les accès requis pour le CPU (combinaison de eACCESS_TYPE). Plus de détails...

uint8_t	m_gpuAccess
	Les accès requis pour le GPU (combinaison de eACCESS_TYPE). 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

C3D_API Castor3D::Texture::Texture	(	eTEXTURE_BASE_TYPE	p_type,
		RenderSystem &	p_renderSystem,
		uint8_t	p_cpuAccess,
		uint8_t	p_gpuAccess
	)

Constructeur.

Paramètres

[in]	p_type	Le type de texture.
[in]	p_renderSystem	Le render system.
[in]	p_cpuAccess	Les accès requis pour le CPU (combinaison de eACCESS_TYPE).
[in]	p_gpuAccess	Les accès requis pour le GPU (combinaison de eACCESS_TYPE).

virtual C3D_API Castor3D::Texture::~Texture ( )

virtual

Destructeur.

Documentation des fonctions membres

C3D_API bool Castor3D::Texture::Bind ( uint32_t p_index ) const

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

Paramètres

[in] p_index L'index de texture

Renvoie: true si tout s'est bien passé

virtual C3D_API void Castor3D::Texture::Cleanup ( )

pure virtual

Fonction de nettoyage.

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

virtual C3D_API bool Castor3D::Texture::Create ( )

pure virtual

Fonction de création.

Renvoie: true si tout s'est bien passé

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

protected

Référencé par GetBuffer().

Voici le graphe des appelants de cette fonction :

virtual C3D_API void Castor3D::Texture::Destroy ( )

pure virtual

Fonction de destruction.

virtual C3D_API bool Castor3D::Texture::DoBind ( uint32_t p_index ) const

protectedpure virtual

Activation spécifique selon l'API.

Renvoie: si tout s'est bien passé

Référencé par GetBuffer().

Voici le graphe des appelants de cette fonction :

virtual C3D_API bool Castor3D::Texture::DoInitialise ( )

protectedpure virtual

Initialisation spécifique selon l'API.

Renvoie: si tout s'est bien passé

Référencé par GetBuffer().

Voici le graphe des appelants de cette fonction :

virtual C3D_API void Castor3D::Texture::DoUnbind ( uint32_t p_index ) const

protectedpure virtual

Désactivation spécifique selon l'API.

Référencé par GetBuffer().

Voici le graphe des appelants de cette fonction :

virtual C3D_API void Castor3D::Texture::GenerateMipmaps ( ) const

pure virtual

Génère les mipmaps de la texture.

eTEXTURE_BASE_TYPE Castor3D::Texture::GetBaseType ( ) const

inline

Récupère le type de texture.

Renvoie: Le type de texture

Références m_baseType.

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

inline

Récupère le buffer de la texture.

Renvoie: Le buffer

Références DECLARE_VECTOR(), DoBind(), DoInitialise(), DoUnbind(), et m_pixelBuffer.

Voici le graphe d'appel pour cette fonction :

uint32_t Castor3D::Texture::GetDepth ( ) const

inline

Récupère la profondeur de la texture.

Renvoie: La profondeur, 1 si pas 3D

Références m_depth.

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

inline

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

Renvoie: Les dimensions de l'image

Références GetHeight(), et GetWidth().

Voici le graphe d'appel pour cette fonction :

uint32_t Castor3D::Texture::GetHeight ( ) const

inline

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

Renvoie: La hauteur

Références m_depth, m_pixelBuffer, et m_size.

Référencé par GetDimensions().

Voici le graphe des appelants de cette fonction :

eTEXTURE_MAP_MODE Castor3D::Texture::GetMappingMode ( ) const

inline

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

Renvoie: Le mode mappage de la texture

Références m_mapMode.

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

inline

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

Renvoie: Le format des pixels

Références m_pixelBuffer, et m_pixelFormat.

eTEXTURE_TYPE Castor3D::Texture::GetType ( ) const

inline

Récupère la dimension de la texture.

Renvoie: La dimension de la texture

Références m_type.

uint32_t Castor3D::Texture::GetWidth ( ) const

inline

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

Renvoie: La largeur

Références m_pixelBuffer, et m_size.

Référencé par GetDimensions().

Voici le graphe des appelants de cette fonction :

virtual C3D_API bool Castor3D::Texture::Initialise ( )

pure virtual

Fonction d'initialisation.

Renvoie: true si tout s'est bien passé.

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

bool Castor3D::Texture::IsInitialised ( ) const

inline

Récupère le statut d'initialisation.

Renvoie: Le statut d'initialisation

Références m_initialised.

virtual C3D_API uint8_t* Castor3D::Texture::Lock ( uint32_t p_lock )

pure virtual

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

Paramètres

[in] p_lock Définit le mode de lock (lecture, écriture, les 2), combinaison de eACCESS_TYPE

Renvoie: Le buffer de l'image

C3D_API void Castor3D::Texture::SetImage ( Castor::PxBufferBaseSPtr p_buffer )

Définit le buffer de la texture.

Paramètres

[in] p_buffer Le buffer

Référencé par Castor3D::DynamicTexture::SetSamplesCount().

Voici le graphe des appelants de cette fonction :

void Castor3D::Texture::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

Références m_mapMode.

void Castor3D::Texture::SetType ( eTEXTURE_TYPE p_dimension )

inline

Définit la dimension de la texture.

Paramètres

[in] p_dimension La dimension de la texture

Références m_type.

C3D_API void Castor3D::Texture::Unbind ( uint32_t p_index ) const

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

Paramètres

[in] p_index L'index de texture

virtual C3D_API void Castor3D::Texture::Unlock ( bool p_modified )

pure virtual

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

Paramètres

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

Documentation des données membres

eTEXTURE_BASE_TYPE Castor3D::Texture::m_baseType

protected

La type de base de la texture.

Référencé par GetBaseType().

uint8_t Castor3D::Texture::m_cpuAccess

protected

Les accès requis pour le CPU (combinaison de eACCESS_TYPE).

uint32_t Castor3D::Texture::m_depth

protected

Profondeur de la texture 3D.

Référencé par GetDepth(), et GetHeight().

uint8_t Castor3D::Texture::m_gpuAccess

protected

Les accès requis pour le GPU (combinaison de eACCESS_TYPE).

bool Castor3D::Texture::m_initialised

protected

Statut d'initialisation.

Référencé par IsInitialised().

eTEXTURE_MAP_MODE Castor3D::Texture::m_mapMode

protected

Modes de mappage de la texture.

Référencé par GetMappingMode(), et SetMappingMode().

Castor::PxBufferBaseSPtr Castor3D::Texture::m_pixelBuffer

protected

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

Référencé par GetBuffer(), GetHeight(), GetPixelFormat(), et GetWidth().

Castor::ePIXEL_FORMAT Castor3D::Texture::m_pixelFormat

protected

Le format du buffer de pixels.

Référencé par GetPixelFormat().

Castor::Size Castor3D::Texture::m_size

protected

Les dimensions du buffer de pixels.

Référencé par GetHeight(), et GetWidth().

eTEXTURE_TYPE Castor3D::Texture::m_type

protected

Type de texture.

Référencé par GetType(), et SetType().

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

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

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres