Castor3D::FontTexture Class Reference

Contains the font and the texture assiated to this font. More...

Inheritance diagram for Castor3D::FontTexture:

Collaboration diagram for Castor3D::FontTexture:

Public Member Functions
	DECLARE_MAP (char32_t, Castor::Position, GlyphPosition)
C3D_API	FontTexture (Engine &p_engine, Castor::FontSPtr p_font)
	Constructor. More...
C3D_API	~FontTexture ()
	Destructor. More...
C3D_API void	Initialise ()
	Initialises the texture. More...
C3D_API void	Cleanup ()
	Flushes the teture. More...
C3D_API void	Update ()
	Updates the glyphs. More...
C3D_API Castor::String const &	GetFontName () const
	Retrieves the font name. More...
C3D_API Castor::Position const &	GetGlyphPosition (char32_t p_char) const
	Retrieves the wanted glyph position. More...
Castor::FontSPtr	GetFont () const
	Retrieves the font. More...
TextureSPtr	GetTexture () const
	Retrieves the texture. More...
SamplerSPtr	GetSampler () const
	Retrieves the texture. More...
uint32_t	Connect (std::function< void(FontTexture const &) > p_function)
	Connects a client to the changed notification signal. More...
void	Disconnect (uint32_t p_connection)
	Disconnects a client from the changed notification signal. More...

Detailed Description

Contains the font and the texture assiated to this font.

Author

Sylvain DOREMUS

Version

0.8.0

Date

04/10/2015

Constructor & Destructor Documentation

FontTexture()

C3D_API Castor3D::FontTexture::FontTexture	(	Engine &	p_engine,
		Castor::FontSPtr	p_font
	)

Constructor.

Parameters

[in]	p_engine	The engine.
[in]	p_font	The font.

~FontTexture()

C3D_API Castor3D::FontTexture::~FontTexture

(

)

Destructor.

Member Function Documentation

Cleanup()

C3D_API void Castor3D::FontTexture::Cleanup

(

)

Flushes the teture.

Connect()

uint32_t Castor3D::FontTexture::Connect ( std::function< void(FontTexture const &) >  p_function )

inline

Connects a client to the changed notification signal.

Parameters

[in]

p_function

The client function.

Returns

The connection.

DECLARE_MAP()

Castor3D::FontTexture::DECLARE_MAP	(	char32_t	,
		Castor::Position	,
		GlyphPosition
	)

Disconnect()

void Castor3D::FontTexture::Disconnect ( uint32_t  p_connection )

inline

Disconnects a client from the changed notification signal.

Returns

The connection.

GetFont()

Castor::FontSPtr Castor3D::FontTexture::GetFont ( ) const

inline

Retrieves the font.

Returns

The value.

GetFontName()

C3D_API Castor::String const& Castor3D::FontTexture::GetFontName

(

)

const

Retrieves the font name.

Returns

The value.

GetGlyphPosition()

C3D_API Castor::Position const& Castor3D::FontTexture::GetGlyphPosition

(

char32_t

p_char

)

const

Retrieves the wanted glyph position.

Parameters

[in]

p_char

The glyph index.

Returns

The position.

GetSampler()

SamplerSPtr Castor3D::FontTexture::GetSampler ( ) const

inline

Retrieves the texture.

Returns

The texture.

GetTexture()

TextureSPtr Castor3D::FontTexture::GetTexture ( ) const

inline

Retrieves the texture.

Returns

The texture.

Initialise()

C3D_API void Castor3D::FontTexture::Initialise

(

)

Initialises the texture.

Update()

C3D_API void Castor3D::FontTexture::Update

(

)

Updates the glyphs.

---

The documentation for this class was generated from the following file:

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/FontTexture.hpp