Font implementation for bitmap fonts. More...

#include <kanzi/core.ui/font/bitmap_font_file.hpp>

Inheritance diagram for kanzi::BitmapFontFile:

Classes
class	BitmapGlyphData
	Derived GlyphData implementation for bitmap fonts. More...

class	KerningPairHasher
	Class providing hash operator for bitmap font kerning pairs. More...

Public Member Functions
float	getAdvance (unsigned int glyphIndex) const override
	Returns the advance metric of the given glyph. More...

float	getAscender () const override
	Returns the ascender of the font. More...

RectangleFloat	getBoundingBox (unsigned int glyphIndex) const override
	Returns the bounding box of the given glyph. More...

float	getDescender () const override
	Returns the descender of the font. More...

GlyphDataSharedPtr	getGlyphData (unsigned int glyphIndex) override
	Returns the bitmap data for the given glyph. More...

unsigned int	getGlyphIndex (char32_t character) const override
	Returns the glyph index in the font for the given unicode code point. More...

float	getKerning (unsigned int previousGlyphIndex, unsigned int glyphIndex) const override
	Returns the kerning between the given pair of glyphs. More...

float	getLineHeight () const override
	Returns the line height of the font. More...

float	getSize () const override
	Returns the size of the font. More...

void	loadTextureFromBitmap (BitmapImageUniquePtr image, unsigned int index, string_view name)
	Loads the given texture. More...

void	loadTextureFromMemory (const byte *data, GraphicsFormat format, unsigned int width, unsigned int height, bool flipTexture, unsigned int index, string_view name)
	Creates a texture by copying the pixel data from memory and loads the created texture. More...

void	loadTexturesFromPath (string_view path)
	Loads textures required by this font from the given path. More...

void	resetScaling ()
	Resets the bitmap font to its native size. More...

void	setSize (float size) override
	Sets the size of the font in pixels. More...

	~BitmapFontFile () override
	Destructor. More...

Public Member Functions inherited from kanzi::FontFile
virtual FontEnginePlugin::FontEngine	getEngineType () const
	Returns the font engine type used by this font. More...

FontHintingPreference	getHintingPreference () const
	Gets the value of FontStyleConcept::HintingPreferenceProperty. More...

void	setHintingPreference (FontHintingPreference hintingPreference)
	Sets the value of FontStyleConcept::HintingPreferenceProperty. More...

	~FontFile () override
	Destructor. More...

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

const string &	getName () const
	Gets the resource name. More...

const string &	getUrl () const
	Gets the resource URL. More...

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

void	setUrl (string_view url)
	Sets the resource URL. More...

	~Resource () override
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	applyObjectStyles ()
	Apply all styles for an object node. More...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Friends
class	BitmapFontLoader

Additional Inherited Members
Public Types inherited from kanzi::FontFile
typedef shared_ptr< GlyphData >	GlyphDataSharedPtr

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Static Public Member Functions inherited from kanzi::FontFile
static FontFileSharedPtr	create (Domain *domain, string_view name)
	Construct fonts using the corresponding font loader implementation, not directly with the create() function. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Member Functions inherited from kanzi::FontFile
	FontFile (Domain *domain, string_view name)
	Construct fonts using the corresponding font loader implementation, not directly with the constructor. More...

void	setAscender (float ascender)
	Sets the ascender for a font. More...

void	setDescender (float descender)
	Sets the descender for a font. More...

void	setLineHeight (float lineHeight)
	Sets the line height for a font. More...

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Font implementation for bitmap fonts.

Supported bitmap fonts consist of a plain text fnt definition file and one or more bitmaps containing the pre-rendered glyphs at a certain size.

Constructor & Destructor Documentation

◆ ~BitmapFontFile()

kanzi::BitmapFontFile::~BitmapFontFile ( )

override

Destructor.

Member Function Documentation

◆ setSize()

void kanzi::BitmapFontFile::setSize ( float size )

overridevirtual

Sets the size of the font in pixels.

Parameters

size	Size in pixels.

Reimplemented from kanzi::FontFile.

◆ getGlyphIndex()

unsigned int kanzi::BitmapFontFile::getGlyphIndex ( char32_t character ) const

overridevirtual

Returns the glyph index in the font for the given unicode code point.

Parameters

character The unicode code point to use.

Returns: Glyph index for the given unicode code point.

Reimplemented from kanzi::FontFile.

◆ getAdvance()

float kanzi::BitmapFontFile::getAdvance ( unsigned int glyphIndex ) const

overridevirtual

Returns the advance metric of the given glyph.

Parameters

glyphIndex Index of the font glyph data acquired from getGlyphIndex().

Returns: Advance of the given glyph.

Reimplemented from kanzi::FontFile.

◆ getBoundingBox()

RectangleFloat kanzi::BitmapFontFile::getBoundingBox ( unsigned int glyphIndex ) const

overridevirtual

Returns the bounding box of the given glyph.

Parameters

glyphIndex Index of the font glyph data acquired from getGlyphIndex().

Returns: Bounding box of the given glyph.

Reimplemented from kanzi::FontFile.

◆ getKerning()

float kanzi::BitmapFontFile::getKerning	(	unsigned int	previousGlyphIndex,
		unsigned int	glyphIndex
	)		const

overridevirtual

Returns the kerning between the given pair of glyphs.

Parameters

previousGlyphIndex	Index of the font glyph data of the preceding glyph.
glyphIndex	Index of the font glyph data acquired from getGlyphIndex().

Returns: Kerning between the given glyph pair.

Reimplemented from kanzi::FontFile.

◆ getGlyphData()

GlyphDataSharedPtr kanzi::BitmapFontFile::getGlyphData ( unsigned int glyphIndex )

overridevirtual

Returns the bitmap data for the given glyph.

Parameters

glyphIndex Index of the font glyph data acquired from getGlyphIndex().

Returns: Bitmap data for the given glyph.

Reimplemented from kanzi::FontFile.

◆ getSize()

float kanzi::BitmapFontFile::getSize ( ) const

overridevirtual

Returns the size of the font.

Returns: Size of the font.

Reimplemented from kanzi::FontFile.

◆ getLineHeight()

float kanzi::BitmapFontFile::getLineHeight ( ) const

overridevirtual

Returns the line height of the font.

Returns: Line height of the font.

Reimplemented from kanzi::FontFile.

◆ getAscender()

float kanzi::BitmapFontFile::getAscender ( ) const

overridevirtual

Returns the ascender of the font.

Returns: Ascender of the font.

Reimplemented from kanzi::FontFile.

◆ getDescender()

float kanzi::BitmapFontFile::getDescender ( ) const

overridevirtual

Returns the descender of the font.

Returns: Descender of the font.

Reimplemented from kanzi::FontFile.

◆ resetScaling()

void kanzi::BitmapFontFile::resetScaling ( )

Resets the bitmap font to its native size.

◆ loadTexturesFromPath()

void kanzi::BitmapFontFile::loadTexturesFromPath ( string_view path )

Loads textures required by this font from the given path.

If you create a FontFile object with BitmapFontLoader::createFontFromFile or BitmapFontLoader::createFontFromMemory, you need this function to complete the font loading.

Parameters

path	Path where the textures are located.

◆ loadTextureFromBitmap()

void kanzi::BitmapFontFile::loadTextureFromBitmap	(	BitmapImageUniquePtr	image,
		unsigned int	index,
		string_view	name
	)

Loads the given texture.

You can use this function as an alternative to loadTexturesFromPath().

Parameters

image	Pointer to the bitmap to use.
index	Index number of the bitmap, as defined in the font definition file.
name	Name to use for the created texture.

◆ loadTextureFromMemory()

void kanzi::BitmapFontFile::loadTextureFromMemory	(	const byte *	data,
		GraphicsFormat	format,
		unsigned int	width,
		unsigned int	height,
		bool	flipTexture,
		unsigned int	index,
		string_view	name
	)

Creates a texture by copying the pixel data from memory and loads the created texture.

You can use this function as alternative to loadTexturesFromPath() or loadTextureFromBitmap().

Parameters

data	The pixel data to copy. Must cover the width * height * bytes_per_pixel of memory.
format	The graphics format.
width	The width in pixels.
height	The height in pixels.
flipTexture	Tells whether Kanzi flips the texture data vertically before storing it as a texture.
index	Index number of the bitmap, as defined in the font definition file.
name	Name to use for the created texture.

Friends And Related Function Documentation

◆ BitmapFontLoader

friend class BitmapFontLoader

friend

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

kanzi/core.ui/font/bitmap_font_file.hpp

Classes

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~BitmapFontFile()

Member Function Documentation

◆ setSize()

◆ getGlyphIndex()

◆ getAdvance()

◆ getBoundingBox()

◆ getKerning()

◆ getGlyphData()

◆ getSize()

◆ getLineHeight()

◆ getAscender()

◆ getDescender()

◆ resetScaling()

◆ loadTexturesFromPath()

◆ loadTextureFromBitmap()

◆ loadTextureFromMemory()

Friends And Related Function Documentation

◆ BitmapFontLoader