A typeface that can be populated with custom glyphs. More...

#include <juce_CustomTypeface.h>

Inheritance diagram for juce::CustomTypeface:

Collaboration diagram for juce::CustomTypeface:

[legend]

Public Types
using	Ptr = ReferenceCountedObjectPtr< Typeface >
	A handy typedef for a pointer to a typeface. More...

Public Member Functions
	CustomTypeface ()
	Creates a new, empty typeface. More...

	CustomTypeface (InputStream &serialisedTypefaceStream)
	Loads a typeface from a previously saved stream. More...

	~CustomTypeface () override
	Destructor. More...

void	addGlyph (juce_wchar character, const Path &path, float width) noexcept
	Adds a glyph to the typeface. More...

void	addGlyphsFromOtherTypeface (Typeface &typefaceToCopy, juce_wchar characterStartIndex, int numCharacters) noexcept
	Adds a range of glyphs from another typeface. More...

void	addKerningPair (juce_wchar char1, juce_wchar char2, float extraAmount) noexcept
	Specifies an extra kerning amount to be used between a pair of characters. More...

void	applyVerticalHintingTransform (float fontHeight, Path &path)
	Makes an attempt at performing a good overall distortion that will scale a font of the given size to align vertically with the pixel grid. More...

void	clear ()
	Resets this typeface, deleting all its glyphs and settings. More...

void	decReferenceCount () noexcept
	Decreases the object's reference count. More...

bool	decReferenceCountWithoutDeleting () noexcept
	Decreases the object's reference count. More...

float	getAscent () const override
	Returns the ascent of the font, as a proportion of its height. More...

float	getDescent () const override
	Returns the descent of the font, as a proportion of its height. More...

EdgeTable *	getEdgeTableForGlyph (int glyphNumber, const AffineTransform &, float fontHeight) override
	Returns a new EdgeTable that contains the path for the given glyph, with the specified transform applied. More...

void	getGlyphPositions (const String &, Array< int > &glyphs, Array< float > &xOffsets) override
	Converts a line of text into its glyph numbers and their positions. More...

float	getHeightToPointsFactor () const override
	Returns the value by which you should multiply a JUCE font-height value to convert it to the equivalent point-size. More...

const String &	getName () const noexcept
	Returns the font family of the typeface. More...

bool	getOutlineForGlyph (int glyphNumber, Path &) override
	Returns the outline for a glyph. More...

int	getReferenceCount () const noexcept
	Returns the object's current reference count. More...

float	getStringWidth (const String &) override
	Measures the width of a line of text. More...

const String &	getStyle () const noexcept
	Returns the font style of the typeface. More...

void	incReferenceCount () noexcept
	Increments the object's reference count. More...

virtual bool	isHinted () const
	Returns true if the typeface uses hinting. More...

virtual bool	isSuitableForFont (const Font &) const
	Returns true if this typeface can be used to render the specified font. More...

void	setCharacteristics (const String &fontFamily, const String &fontStyle, float ascent, juce_wchar defaultCharacter) noexcept
	Sets the vital statistics for the typeface. More...

void	setCharacteristics (const String &fontFamily, float ascent, bool isBold, bool isItalic, juce_wchar defaultCharacter) noexcept
	Sets the vital statistics for the typeface. More...

bool	writeToStream (OutputStream &outputStream)
	Saves this typeface as a Juce-formatted font file. More...

Static Public Member Functions
static void	clearTypefaceCache ()
	Clears any fonts that are currently cached in memory. More...

static Ptr	createSystemTypefaceFor (const Font &font)
	Creates a new system typeface. More...

static Ptr	createSystemTypefaceFor (const void *fontFileData, size_t fontFileDataSize)
	Attempts to create a font from some raw font file data (e.g. More...

static void	scanFolderForFonts (const File &folder)
	On some platforms, this allows a specific path to be scanned. More...

static void	setTypefaceCacheSize (int numFontsToCache)
	Changes the number of fonts that are cached in memory. More...

Protected Member Functions
virtual bool	loadGlyphIfPossible (juce_wchar characterNeeded)
	If a subclass overrides this, it can load glyphs into the font on-demand. More...

void	resetReferenceCount () noexcept
	Resets the reference count to zero without deleting the object. More...

Static Protected Member Functions
static Ptr	getFallbackTypeface ()

Protected Attributes
float	ascent

juce_wchar	defaultCharacter

String	name

String	style

Private Member Functions
GlyphInfo *	findGlyph (const juce_wchar character, bool loadIfNeeded) noexcept

Private Attributes
OwnedArray< GlyphInfo >	glyphs

CriticalSection	hintingLock

std::unique_ptr< HintingParams >	hintingParams

short	lookupTable [128]

Atomic< int >	refCount { 0 }

Detailed Description

A typeface that can be populated with custom glyphs.

You can create a CustomTypeface if you need one that contains your own glyphs, or if you need to load a typeface from a Juce-formatted binary stream.

If you want to create a copy of a native face, you can use addGlyphsFromOtherTypeface() to copy glyphs into this face.

NOTE! For most people this class is almost certainly NOT the right tool to use! If what you want to do is to embed a font into your exe, then your best plan is probably to embed your TTF/OTF font file into your binary using the Projucer, and then call Typeface::createSystemTypefaceFor() to load it from memory.

See also: Typeface, Font

@tags{Graphics}

Member Typedef Documentation

◆ Ptr

using juce::Typeface::Ptr = ReferenceCountedObjectPtr<Typeface>

inherited

A handy typedef for a pointer to a typeface.

Constructor & Destructor Documentation

◆ CustomTypeface() [1/2]

juce::CustomTypeface::CustomTypeface ( )

Creates a new, empty typeface.

◆ CustomTypeface() [2/2]

juce::CustomTypeface::CustomTypeface ( InputStream & serialisedTypefaceStream )

explicit

Loads a typeface from a previously saved stream.

The stream must have been created by writeToStream().

NOTE! Since this class was written, support was added for loading real font files from memory, so for most people, using Typeface::createSystemTypefaceFor() to load a real font is more appropriate than using this class to store it in a proprietary format.

See also: writeToStream

◆ ~CustomTypeface()

juce::CustomTypeface::~CustomTypeface ( )

override

Destructor.

Member Function Documentation

◆ addGlyph()

void juce::CustomTypeface::addGlyph	(	juce_wchar	character,
		const Path &	path,
		float	width
	)

noexcept

Adds a glyph to the typeface.

The path that is passed in is normalised so that the font height is 1.0, and its origin is the anchor point of the character on its baseline.

The width is the nominal width of the character, and any extra kerning values that are specified will be added to this width.

◆ addGlyphsFromOtherTypeface()

void juce::CustomTypeface::addGlyphsFromOtherTypeface	(	Typeface &	typefaceToCopy,
		juce_wchar	characterStartIndex,
		int	numCharacters
	)

noexcept

Adds a range of glyphs from another typeface.

This will attempt to pull in the paths and kerning information from another typeface and add it to this one.

◆ addKerningPair()

void juce::CustomTypeface::addKerningPair	(	juce_wchar	char1,
		juce_wchar	char2,
		float	extraAmount
	)

noexcept

Specifies an extra kerning amount to be used between a pair of characters.

The amount will be added to the nominal width of the first character when laying out a string.

◆ applyVerticalHintingTransform()

void juce::Typeface::applyVerticalHintingTransform	(	float	fontHeight,
		Path &	path
	)

inherited

Makes an attempt at performing a good overall distortion that will scale a font of the given size to align vertically with the pixel grid.

The path should be an unscaled (i.e. normalised to height of 1.0) path for a glyph.

◆ clear()

void juce::CustomTypeface::clear ( )

Resets this typeface, deleting all its glyphs and settings.

◆ clearTypefaceCache()

static void juce::Typeface::clearTypefaceCache ( )

staticinherited

Clears any fonts that are currently cached in memory.

◆ createSystemTypefaceFor() [1/2]

static Ptr juce::Typeface::createSystemTypefaceFor ( const Font & font )

staticinherited

Creates a new system typeface.

◆ createSystemTypefaceFor() [2/2]

static Ptr juce::Typeface::createSystemTypefaceFor	(	const void *	fontFileData,
		size_t	fontFileDataSize
	)

staticinherited

Attempts to create a font from some raw font file data (e.g.

a TTF or OTF file image). The system will take its own internal copy of the data, so you can free the block once this method has returned.

◆ decReferenceCount()

void juce::ReferenceCountedObject::decReferenceCount ( )

inlinenoexceptinherited

Decreases the object's reference count.

If the count gets to zero, the object will be deleted.

References jassert.

◆ decReferenceCountWithoutDeleting()

bool juce::ReferenceCountedObject::decReferenceCountWithoutDeleting ( )

inlinenoexceptinherited

Decreases the object's reference count.

If the count gets to zero, the object will not be deleted, but this method will return true, allowing the caller to take care of deletion.

References jassert.

◆ findGlyph()

GlyphInfo* juce::CustomTypeface::findGlyph	(	const juce_wchar	character,
		bool	loadIfNeeded
	)

privatenoexcept

◆ getAscent()

float juce::CustomTypeface::getAscent ( ) const

overridevirtual

Returns the ascent of the font, as a proportion of its height.

The height is considered to always be normalised as 1.0, so this will be a value less that 1.0, indicating the proportion of the font that lies above its baseline.

Implements juce::Typeface.

◆ getDescent()

float juce::CustomTypeface::getDescent ( ) const

overridevirtual

Returns the descent of the font, as a proportion of its height.

The height is considered to always be normalised as 1.0, so this will be a value less that 1.0, indicating the proportion of the font that lies below its baseline.

Implements juce::Typeface.

◆ getEdgeTableForGlyph()

EdgeTable* juce::CustomTypeface::getEdgeTableForGlyph	(	int	glyphNumber,
		const AffineTransform &	transform,
		float	fontHeight
	)

overridevirtual

Returns a new EdgeTable that contains the path for the given glyph, with the specified transform applied.

Reimplemented from juce::Typeface.

◆ getFallbackTypeface()

static Ptr juce::Typeface::getFallbackTypeface ( )

staticprotectedinherited

◆ getGlyphPositions()

void juce::CustomTypeface::getGlyphPositions	(	const String &	text,
		Array< int > &	glyphs,
		Array< float > &	xOffsets
	)

overridevirtual

Converts a line of text into its glyph numbers and their positions.

The distances returned are based on the font having an normalised height of 1.0. You should never need to call this directly! Use Font::getGlyphPositions() instead!

Implements juce::Typeface.

◆ getHeightToPointsFactor()

float juce::CustomTypeface::getHeightToPointsFactor ( ) const

overridevirtual

Returns the value by which you should multiply a JUCE font-height value to convert it to the equivalent point-size.

Implements juce::Typeface.

◆ getName()

const String& juce::Typeface::getName ( ) const

inlinenoexceptinherited

Returns the font family of the typeface.

See also: Font::getTypefaceName

References juce::gl::name.

◆ getOutlineForGlyph()

bool juce::CustomTypeface::getOutlineForGlyph	(	int	glyphNumber,
		Path &	path
	)

overridevirtual

Returns the outline for a glyph.

The path returned will be normalised to a font height of 1.0.

Implements juce::Typeface.

◆ getReferenceCount()

int juce::ReferenceCountedObject::getReferenceCount ( ) const

inlinenoexceptinherited

Returns the object's current reference count.

◆ getStringWidth()

float juce::CustomTypeface::getStringWidth ( const String & text )

overridevirtual

Measures the width of a line of text.

The distance returned is based on the font having an normalised height of 1.0. You should never need to call this directly! Use Font::getStringWidth() instead!

Implements juce::Typeface.

◆ getStyle()

const String& juce::Typeface::getStyle ( ) const

inlinenoexceptinherited

Returns the font style of the typeface.

See also: Font::getTypefaceStyle

◆ incReferenceCount()

void juce::ReferenceCountedObject::incReferenceCount ( )

inlinenoexceptinherited

Increments the object's reference count.

This is done automatically by the smart pointer, but is public just in case it's needed for nefarious purposes.

Referenced by juce::ReferenceCountedObjectPtr< juce::ReferenceCountedObject >::operator=().

◆ isHinted()

virtual bool juce::Typeface::isHinted ( ) const

inlinevirtualinherited

Returns true if the typeface uses hinting.

◆ isSuitableForFont()

virtual bool juce::Typeface::isSuitableForFont ( const Font & ) const

inlinevirtualinherited

Returns true if this typeface can be used to render the specified font.

When called, the font will already have been checked to make sure that its name and style flags match the typeface.

◆ loadGlyphIfPossible()

virtual bool juce::CustomTypeface::loadGlyphIfPossible ( juce_wchar characterNeeded )

protectedvirtual

If a subclass overrides this, it can load glyphs into the font on-demand.

When methods such as getGlyphPositions() or getOutlineForGlyph() are asked for a particular character and there's no corresponding glyph, they'll call this method so that a subclass can try to add that glyph, returning true if it manages to do so.

◆ resetReferenceCount()

void juce::ReferenceCountedObject::resetReferenceCount ( )

inlineprotectednoexceptinherited

Resets the reference count to zero without deleting the object.

You should probably never need to use this!

◆ scanFolderForFonts()

static void juce::Typeface::scanFolderForFonts ( const File & folder )

staticinherited

On some platforms, this allows a specific path to be scanned.

On macOS you can load .ttf and .otf files, otherwise this is only available when using FreeType.

◆ setCharacteristics() [1/2]

void juce::CustomTypeface::setCharacteristics	(	const String &	fontFamily,
		const String &	fontStyle,
		float	ascent,
		juce_wchar	defaultCharacter
	)

noexcept

Sets the vital statistics for the typeface.

Parameters

fontFamily	the typeface's font family
fontStyle	the typeface's font style
ascent	the ascent - this is normalised to a height of 1.0 and this is the value that will be returned by Typeface::getAscent(). The descent is assumed to be (1.0 - ascent)
defaultCharacter	the character to be used as a replacement if there's no glyph available for the character that's being drawn

◆ setCharacteristics() [2/2]

void juce::CustomTypeface::setCharacteristics	(	const String &	fontFamily,
		float	ascent,
		bool	isBold,
		bool	isItalic,
		juce_wchar	defaultCharacter
	)

noexcept

Sets the vital statistics for the typeface.

Parameters

fontFamily	the typeface's font family
ascent	the ascent - this is normalised to a height of 1.0 and this is the value that will be returned by Typeface::getAscent(). The descent is assumed to be (1.0 - ascent)
isBold	should be true if the typeface is bold
isItalic	should be true if the typeface is italic
defaultCharacter	the character to be used as a replacement if there's no glyph available for the character that's being drawn

◆ setTypefaceCacheSize()

static void juce::Typeface::setTypefaceCacheSize ( int numFontsToCache )

staticinherited

Changes the number of fonts that are cached in memory.

◆ writeToStream()

bool juce::CustomTypeface::writeToStream ( OutputStream & outputStream )

Saves this typeface as a Juce-formatted font file.

A CustomTypeface can be created to reload the data that is written - see the CustomTypeface constructor.

NOTE! Since this class was written, support was added for loading real font files from memory, so for most people, using Typeface::createSystemTypefaceFor() to load a real font is more appropriate than using this class to store it in a proprietary format.

Member Data Documentation

◆ ascent

float juce::CustomTypeface::ascent

protected

◆ defaultCharacter

juce_wchar juce::CustomTypeface::defaultCharacter

protected

◆ glyphs

OwnedArray<GlyphInfo> juce::CustomTypeface::glyphs

private

◆ hintingLock

CriticalSection juce::Typeface::hintingLock

privateinherited

◆ hintingParams

std::unique_ptr<HintingParams> juce::Typeface::hintingParams

privateinherited

◆ lookupTable

short juce::CustomTypeface::lookupTable[128]

private

◆ name

String juce::Typeface::name

protectedinherited

◆ refCount

Atomic<int> juce::ReferenceCountedObject::refCount { 0 }

privateinherited

◆ style

String juce::Typeface::style

protectedinherited

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

juce_CustomTypeface.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ CustomTypeface() [1/2]

◆ CustomTypeface() [2/2]

◆ ~CustomTypeface()

Member Function Documentation

◆ addGlyph()

◆ addGlyphsFromOtherTypeface()

◆ addKerningPair()

◆ applyVerticalHintingTransform()

◆ clear()

◆ clearTypefaceCache()

◆ createSystemTypefaceFor() [1/2]

◆ createSystemTypefaceFor() [2/2]

◆ decReferenceCount()

◆ decReferenceCountWithoutDeleting()

◆ findGlyph()

◆ getAscent()

◆ getDescent()

◆ getEdgeTableForGlyph()

◆ getFallbackTypeface()

◆ getGlyphPositions()

◆ getHeightToPointsFactor()

◆ getName()

◆ getOutlineForGlyph()

◆ getReferenceCount()

◆ getStringWidth()

◆ getStyle()

◆ incReferenceCount()

◆ isHinted()

◆ isSuitableForFont()

◆ loadGlyphIfPossible()

◆ resetReferenceCount()

◆ scanFolderForFonts()

◆ setCharacteristics() [1/2]

◆ setCharacteristics() [2/2]

◆ setTypefaceCacheSize()

◆ writeToStream()

Member Data Documentation

◆ ascent

◆ defaultCharacter

◆ glyphs

◆ hintingLock

◆ hintingParams

◆ lookupTable

◆ name

◆ refCount

◆ style