Référence de la classe castor3d::FontTexture

#include <FontTexture.hpp>

Graphe d'héritage de castor3d::FontTexture:

Graphe de collaboration de castor3d::FontTexture:

Fonctions membres publiques
	CU_DeclareMap (char32_t, castor::Position, GlyphPosition)
C3D_API	FontTexture (Engine &engine, castor::FontResPtr font)
	Constructeur.
C3D_API	~FontTexture () noexcept override
	Destructeur.
C3D_API void	initialise (RenderDevice const &device, QueueData const &queueData)
	Initialise la texture.
C3D_API void	cleanup (RenderDevice const &device)
	Nettoie la texture.
C3D_API void	upload (ashes::CommandBuffer const &commandBuffer)
	Upload le buffer d'informations des glyphes.
C3D_API castor::UInt32Array	convert (castor::U32String const &text) const
	Convertit un texte en tableau d'index de glyphe.
C3D_API castor::String const &	getFontName () const
	Récupère le nom de la police.
C3D_API castor::Position const &	getGlyphPosition (char32_t glyphChar) const
	Récupère la position de la glyphe voulue.
castor::FontRPtr	getFont () const
FontGlyphBuffer const &	getFontBuffer () const
TextureLayoutRPtr	getTexture () const
SamplerObs	getSampler () const
void	setId (uint32_t v)
Fonctions membres publiques hérités de castor3d::DoubleBufferedResourceT< ResourceT, PointerT >
void	update (bool clean)
	Met à jour la ressource.
ResourcePtrT const &	getResource () const

Membres hérités additionnels
Types publics hérités de castor3d::DoubleBufferedResourceT< ResourceT, PointerT >
using	ResourcePtrT = PointerT< ResourceT >
using	OnChangedFunction = std::function< void(DoubleBufferedResourceT const &) >
using	OnChanged = castor::SignalT< OnChangedFunction >
Attributs publics hérités de castor3d::DoubleBufferedResourceT< ResourceT, PointerT >
OnChanged	onResourceChanged
Fonctions membres protégées hérités de castor3d::DoubleBufferedResourceT< ResourceT, PointerT >
	DoubleBufferedResourceT (Engine &parent, ResourcePtrT back, ResourcePtrT front)
virtual C3D_API	~DoubleBufferedResourceT () noexcept=default
void	doInitialise (RenderDevice const &device, QueueData const &queueData)
	Initialise la texture.
void	doCleanup ()
	Nettoie la texture.
void	doRefresh (bool clean, bool front)
	Ordonne les évènements pour rafraîchir la ressource.
Attributs protégés hérités de castor3d::DoubleBufferedResourceT< ResourceT, PointerT >
ResourcePtrT	m_back
ResourcePtrT	m_front

Documentation des constructeurs et destructeur

FontTexture()

C3D_API castor3d::FontTexture::FontTexture	(	Engine &	engine,
		castor::FontResPtr	font
	)

Constructeur.

Paramètres

[in]	engine	Le moteur.
[in]	font	La police.

~FontTexture()

C3D_API castor3d::FontTexture::~FontTexture ( )

overridenoexcept

Destructeur.

Documentation des fonctions membres

cleanup()

C3D_API void castor3d::FontTexture::cleanup

(

RenderDevice const &

device

)

Nettoie la texture.

convert()

C3D_API castor::UInt32Array castor3d::FontTexture::convert

(

castor::U32String const &

text

)

const

Convertit un texte en tableau d'index de glyphe.

CU_DeclareMap()

castor3d::FontTexture::CU_DeclareMap	(	char32_t	,
		castor::Position	,
		GlyphPosition
	)

getFont()

castor::FontRPtr castor3d::FontTexture::getFont ( ) const

inline

name Accesseurs.

getFontBuffer()

FontGlyphBuffer const & castor3d::FontTexture::getFontBuffer ( ) const

inline

getFontName()

C3D_API castor::String const & castor3d::FontTexture::getFontName

(

)

const

Récupère le nom de la police.

Renvoie

La valeur.

getGlyphPosition()

C3D_API castor::Position const & castor3d::FontTexture::getGlyphPosition

(

char32_t

glyphChar

)

const

Récupère la position de la glyphe voulue.

Paramètres

[in]

glyphChar

L'indice de la glyphe.

Renvoie

La position.

getSampler()

SamplerObs castor3d::FontTexture::getSampler ( ) const

inline

getTexture()

TextureLayoutRPtr castor3d::FontTexture::getTexture ( ) const

inline

Références castor3d::DoubleBufferedResourceT< ResourceT, PointerT >::getResource().

Voici le graphe d'appel pour cette fonction :

initialise()

C3D_API void castor3d::FontTexture::initialise	(	RenderDevice const &	device,
		QueueData const &	queueData
	)

Initialise la texture.

Paramètres

[in]	device	Le device GPU.
[in]	queueData	La queue recevant les commandes GPU.

setId()

void castor3d::FontTexture::setId ( uint32_t  v )

inline

name Mutateurs.

upload()

C3D_API void castor3d::FontTexture::upload

(

ashes::CommandBuffer const &

commandBuffer

)

Upload le buffer d'informations des glyphes.

---

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

• Overlay/FontTexture.hpp