ramses::GlyphKey Struct Reference

GlyphKey identifies a glyph with a specific font instance. More...

#include <Glyph.h>

Collaboration diagram for ramses::GlyphKey:

Public Member Functions
	GlyphKey ()=default
	Constructor for GlyphKey that initializes members to default values. More...
	GlyphKey (GlyphId _identifier, FontInstanceId _fontInstanceId)
	Constructor for GlyphKey that initializes members to passed values. More...
bool	operator== (const GlyphKey &rhs) const
	Equal comparison operator. More...
bool	operator!= (const GlyphKey &rhs) const
	Unequal comparison operator. More...

Public Attributes
GlyphId	identifier
	Glyph id. More...
FontInstanceId	fontInstanceId
	Font instance id. More...

Detailed Description

GlyphKey identifies a glyph with a specific font instance.

Constructor & Destructor Documentation

GlyphKey() [1/2]

ramses::GlyphKey::GlyphKey ( )

default

Constructor for GlyphKey that initializes members to default values.

GlyphKey() [2/2]

ramses::GlyphKey::GlyphKey ( GlyphId  _identifier, FontInstanceId  _fontInstanceId  )

inline

Constructor for GlyphKey that initializes members to passed values.

Parameters

[in]	_identifier	The glyph id
[in]	_fontInstanceId	The font instance id

Member Function Documentation

operator!=()

bool ramses::GlyphKey::operator!= ( const GlyphKey &  rhs ) const

inline

Unequal comparison operator.

Parameters

[in]

rhs

The glyph key to be compared with

Returns

False if glyph keys are identical, true otherwise

operator==()

bool ramses::GlyphKey::operator== ( const GlyphKey &  rhs ) const

inline

Equal comparison operator.

Parameters

[in]

rhs

The glyph key to be compared with

Returns

True if glyph keys are identical, false otherwise

Member Data Documentation

fontInstanceId

FontInstanceId ramses::GlyphKey::fontInstanceId

Font instance id.

identifier

GlyphId ramses::GlyphKey::identifier

Glyph id.

---

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

• /home/runner/work/ramses/ramses/client/ramses-client/ramses-text-api/include/ramses-text-api/Glyph.h