#include <SkTypeface.h>

Inheritance diagram for SkTypeface:

Classes
struct	LocalizedString

class	LocalizedStrings

Public Types
enum class	SerializeBehavior { kDoIncludeData , kDontIncludeData , kIncludeDataIfLocal }

using	FactoryId = SkFourByteTag

Public Member Functions
SkFontStyle	fontStyle () const

bool	isBold () const

bool	isItalic () const

bool	isFixedPitch () const

int	getVariationDesignPosition (SkFontArguments::VariationPosition::Coordinate coordinates[], int coordinateCount) const

int	getVariationDesignParameters (SkFontParameters::Variation::Axis parameters[], int parameterCount) const

SkTypefaceID	uniqueID () const

sk_sp< SkTypeface >	makeClone (const SkFontArguments &) const

void	serialize (SkWStream *, SerializeBehavior=SerializeBehavior::kIncludeDataIfLocal) const

sk_sp< SkData >	serialize (SerializeBehavior=SerializeBehavior::kIncludeDataIfLocal) const

void	unicharsToGlyphs (const SkUnichar uni[], int count, SkGlyphID glyphs[]) const

int	textToGlyphs (const void *text, size_t byteLength, SkTextEncoding encoding, SkGlyphID glyphs[], int maxGlyphCount) const

SkGlyphID	unicharToGlyph (SkUnichar unichar) const

int	countGlyphs () const

int	countTables () const

int	getTableTags (SkFontTableTag tags[]) const

size_t	getTableSize (SkFontTableTag) const

size_t	getTableData (SkFontTableTag tag, size_t offset, size_t length, void *data) const

sk_sp< SkData >	copyTableData (SkFontTableTag tag) const

int	getUnitsPerEm () const

bool	getKerningPairAdjustments (const SkGlyphID glyphs[], int count, int32_t adjustments[]) const

LocalizedStrings *	createFamilyNameIterator () const

void	getFamilyName (SkString *name) const

bool	getPostScriptName (SkString *name) const

std::unique_ptr< SkStreamAsset >	openStream (int *ttcIndex) const

std::unique_ptr< SkStreamAsset >	openExistingStream (int *ttcIndex) const

std::unique_ptr< SkScalerContext >	createScalerContext (const SkScalerContextEffects &, const SkDescriptor *) const

SkRect	getBounds () const

void	filterRec (SkScalerContextRec *rec) const

void	getFontDescriptor (SkFontDescriptor desc, bool isLocal) const

void *	internal_private_getCTFontRef () const

Public Member Functions inherited from SkWeakRefCnt
	SkWeakRefCnt ()

	~SkWeakRefCnt () override

bool	try_ref () const

void	weak_ref () const

void	weak_unref () const

bool	weak_expired () const

Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()

virtual	~SkRefCntBase ()

bool	unique () const

void	ref () const

void	unref () const

Static Public Member Functions
static bool	Equal (const SkTypeface facea, const SkTypeface faceb)

static sk_sp< SkTypeface >	MakeEmpty ()

static sk_sp< SkTypeface >	MakeDeserialize (SkStream *, sk_sp< SkFontMgr > lastResortMgr)

static void	Register (FactoryId id, sk_sp< SkTypeface >(*make)(std::unique_ptr< SkStreamAsset >, const SkFontArguments &))

Protected Member Functions
	SkTypeface (const SkFontStyle &style, bool isFixedPitch=false)

	~SkTypeface () override

virtual sk_sp< SkTypeface >	onMakeClone (const SkFontArguments &) const =0

void	setIsFixedPitch (bool isFixedPitch)

void	setFontStyle (SkFontStyle style)

virtual std::unique_ptr< SkScalerContext >	onCreateScalerContext (const SkScalerContextEffects &, const SkDescriptor *) const =0

virtual void	onFilterRec (SkScalerContextRec *) const =0

virtual std::unique_ptr< SkAdvancedTypefaceMetrics >	onGetAdvancedMetrics () const =0

virtual void	getPostScriptGlyphNames (SkString *) const =0

virtual void	getGlyphToUnicodeMap (SkUnichar *dstArray) const =0

virtual std::unique_ptr< SkStreamAsset >	onOpenStream (int *ttcIndex) const =0

virtual std::unique_ptr< SkStreamAsset >	onOpenExistingStream (int *ttcIndex) const

virtual bool	onGlyphMaskNeedsCurrentColor () const =0

virtual int	onGetVariationDesignPosition (SkFontArguments::VariationPosition::Coordinate coordinates[], int coordinateCount) const =0

virtual int	onGetVariationDesignParameters (SkFontParameters::Variation::Axis parameters[], int parameterCount) const =0

virtual void	onGetFontDescriptor (SkFontDescriptor , bool isLocal) const =0

virtual void	onCharsToGlyphs (const SkUnichar *chars, int count, SkGlyphID glyphs[]) const =0

virtual int	onCountGlyphs () const =0

virtual int	onGetUPEM () const =0

virtual bool	onGetKerningPairAdjustments (const SkGlyphID glyphs[], int count, int32_t adjustments[]) const

virtual void	onGetFamilyName (SkString *familyName) const =0

virtual bool	onGetPostScriptName (SkString *) const =0

virtual LocalizedStrings *	onCreateFamilyNameIterator () const =0

virtual int	onGetTableTags (SkFontTableTag tags[]) const =0

virtual size_t	onGetTableData (SkFontTableTag, size_t offset, size_t length, void *data) const =0

virtual sk_sp< SkData >	onCopyTableData (SkFontTableTag) const

virtual bool	onComputeBounds (SkRect *) const

virtual void *	onGetCTFontRef () const

Protected Member Functions inherited from SkWeakRefCnt
virtual void	weak_dispose () const

Friends
class	SkScalerContext

class	SkStrikeServerImpl

class	SkTypefaceProxyPrototype

class	SkRandomTypeface

class	SkPDFFont

class	SkFontPriv

Detailed Description

The SkTypeface class specifies the typeface and intrinsic style of a font. This is used in the paint, along with optionally algorithmic settings like textSize, textSkewX, textScaleX, kFakeBoldText_Mask, to specify how text appears when drawn (and measured).

Typeface objects are immutable, and so they can be shared between threads.

Definition at line 52 of file SkTypeface.h.

Member Typedef Documentation

◆ FactoryId

using SkTypeface::FactoryId = SkFourByteTag

Definition at line 335 of file SkTypeface.h.

Member Enumeration Documentation

◆ SerializeBehavior

enum class SkTypeface::SerializeBehavior

strong

A typeface can serialize just a descriptor (names, etc.), or it can also include the actual font data (which can be large). This enum controls how serialize() decides what to serialize.

Enumerator
kDoIncludeData
kDontIncludeData
kIncludeDataIfLocal

Definition at line 124 of file SkTypeface.h.

                                 {
        kDoIncludeData,
        kDontIncludeData,
        kIncludeDataIfLocal,
    };

Constructor & Destructor Documentation

◆ SkTypeface()

SkTypeface::SkTypeface	(	const SkFontStyle &	style,
		bool	isFixedPitch = `false`
	)

explicitprotected

Definition at line 56 of file SkTypeface.cpp.

57 : fUniqueID(SkTypefaceCache::NewTypefaceID()), fStyle(style), fIsFixedPitch(isFixedPitch) { }

SkTypefaceCache::NewTypefaceID

static SkTypefaceID NewTypefaceID()

Definition: SkTypefaceCache.cpp:69

SkTypeface::isFixedPitch

bool isFixedPitch() const

Definition: SkTypeface.h:68

◆ ~SkTypeface()

SkTypeface::~SkTypeface ( )

overrideprotected

Definition at line 59 of file SkTypeface.cpp.

59{ }

Member Function Documentation

◆ copyTableData()

sk_sp< SkData > SkTypeface::copyTableData ( SkFontTableTag tag ) const

Return an immutable copy of the requested font table, or nullptr if that table was not found. This can sometimes be faster than calling getTableData() twice: once to find the length, and then again to copy the data.

Parameters

tag	The table tag whose contents are to be copied

Returns: an immutable copy of the table's data, or nullptr.

Definition at line 318 of file SkTypeface.cpp.

                                                                {
    return this->onCopyTableData(tag);
}

◆ countGlyphs()

int SkTypeface::countGlyphs ( ) const

Return the number of glyphs in the typeface.

Definition at line 432 of file SkTypeface.cpp.

                                  {
    return this->onCountGlyphs();
}

◆ countTables()

int SkTypeface::countTables ( ) const

Return the number of tables in the font.

Definition at line 301 of file SkTypeface.cpp.

                                  {
    return this->onGetTableTags(nullptr);
}

◆ createFamilyNameIterator()

SkTypeface::LocalizedStrings * SkTypeface::createFamilyNameIterator ( ) const

Returns an iterator which will attempt to enumerate all of the family names specified by the font. It is the caller's responsibility to unref() the returned pointer.

Definition at line 455 of file SkTypeface.cpp.

                                                                       {
    return this->onCreateFamilyNameIterator();
}

◆ createScalerContext()

std::unique_ptr< SkScalerContext > SkTypeface::createScalerContext	(	const SkScalerContextEffects &	effects,
		const SkDescriptor *	desc
	)		const

Return a scalercontext for the given descriptor. It may return a stub scalercontext that will not crash, but will draw nothing.

Definition at line 350 of file SkTypeface.cpp.

                                                                               {
    std::unique_ptr<SkScalerContext> scalerContext = this->onCreateScalerContext(effects, desc);
    SkASSERT(scalerContext);
    return scalerContext;
}

◆ Equal()

bool SkTypeface::Equal	(	const SkTypeface *	facea,
		const SkTypeface *	faceb
	)

static

Returns true if the two typefaces reference the same underlying font, handling either being null (treating null as not equal to any font).

Definition at line 149 of file SkTypeface.cpp.

                                                                       {
    if (facea == faceb) {
        return true;
    }
    if (!facea || !faceb) {
        return false;
    }
    return facea->uniqueID() == faceb->uniqueID();
}

◆ filterRec()

void SkTypeface::filterRec ( SkScalerContextRec * rec ) const

inline

Definition at line 322 of file SkTypeface.h.

                                                  {
        this->onFilterRec(rec);
    }

◆ fontStyle()

SkFontStyle SkTypeface::fontStyle ( ) const

inline

Returns the typeface's intrinsic style attributes.

Definition at line 55 of file SkTypeface.h.

                                  {
        return fStyle;
    }

◆ getBounds()

SkRect SkTypeface::getBounds ( ) const

Return a rectangle (scaled to 1-pt) that represents the union of the bounds of all of the glyphs, but each one positioned at (0,). This may be conservatively large, and will not take into account any hinting or other size-specific adjustments.

Definition at line 507 of file SkTypeface.cpp.

                                   {
    fBoundsOnce([this] {
        if (!this->onComputeBounds(&fBounds)) {
            fBounds.setEmpty();
        }
    });
    return fBounds;
}

◆ getFamilyName()

void SkTypeface::getFamilyName ( SkString * name ) const

Return the family name for this typeface. It will always be returned encoded as UTF8, but the language of the name is whatever the host platform chooses.

Definition at line 459 of file SkTypeface.cpp.

                                                   {
    SkASSERT(name);
    this->onGetFamilyName(name);
}

◆ getFontDescriptor()

void SkTypeface::getFontDescriptor	(	SkFontDescriptor *	desc,
		bool *	isLocal
	)		const

inline

Definition at line 326 of file SkTypeface.h.

                                                                        {
        this->onGetFontDescriptor(desc, isLocal);
    }

◆ getGlyphToUnicodeMap()

void SkTypeface::getGlyphToUnicodeMap ( SkUnichar * dstArray ) const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, SkRandomTypeface, TestEmptyTypeface, DWriteFontTypeface, and TestTypeface.

Definition at line 468 of file SkTypeface.cpp.

                                                          {
    sk_bzero(dst, sizeof(SkUnichar) * this->countGlyphs());
}

◆ getKerningPairAdjustments()

bool SkTypeface::getKerningPairAdjustments	(	const SkGlyphID	glyphs[],
		int	count,
		int32_t	adjustments[]
	)		const

Given a run of glyphs, return the associated horizontal adjustments. Adjustments are in "design units", which are integers relative to the typeface's units per em (see getUnitsPerEm).

Some typefaces are known to never support kerning. Calling this method with all zeros (e.g. getKerningPairAdustments(NULL, 0, NULL)) returns a boolean indicating if the typeface might support kerning. If it returns false, then it will always return false (no kerning) for all possible glyph runs. If it returns true, then it may return true for somne glyph runs.

If count is non-zero, then the glyphs parameter must point to at least [count] valid glyph IDs, and the adjustments parameter must be sized to at least [count - 1] entries. If the method returns true, then [count-1] entries in the adjustments array will be set. If the method returns false, then no kerning should be applied, and the adjustments array will be in an undefined state (possibly some values may have been written, but none of them should be interpreted as valid values).

Definition at line 441 of file SkTypeface.cpp.

                                                                        {
    SkASSERT(count >= 0);
    // check for the only legal way to pass a nullptr.. everything is 0
    // in which case they just want to know if this face can possibly support
    // kerning (true) or never (false).
    if (nullptr == glyphs || nullptr == adjustments) {
        SkASSERT(nullptr == glyphs);
        SkASSERT(0 == count);
        SkASSERT(nullptr == adjustments);
    }
    return this->onGetKerningPairAdjustments(glyphs, count, adjustments);
}

◆ getPostScriptGlyphNames()

virtual void SkTypeface::getPostScriptGlyphNames ( SkString * ) const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, TestTypeface, and SkTypeface_FreeType.

◆ getPostScriptName()

bool SkTypeface::getPostScriptName ( SkString * name ) const

Return the PostScript name for this typeface. Value may change based on variation parameters. Returns false if no PostScript name is available.

Definition at line 464 of file SkTypeface.cpp.

                                                       {
    return this->onGetPostScriptName(name);
}

◆ getTableData()

size_t SkTypeface::getTableData	(	SkFontTableTag	tag,
		size_t	offset,
		size_t	length,
		void *	data
	)		const

Copy the contents of a table into data (allocated by the caller). Note that the contents of the table will be in their native endian order (which for most truetype tables is big endian). If the table tag is not found, or there is an error copying the data, then 0 is returned. If this happens, it is possible that some or all of the memory pointed to by data may have been written to, even though an error has occured.

Parameters

tag	The table tag whose contents are to be copied
offset	The offset in bytes into the table's contents where the copy should start from.
length	The number of bytes, starting at offset, of table data to copy.
data	storage address where the table contents are copied to

Returns: the number of bytes actually copied into data. If offset+length exceeds the table's size, then only the bytes up to the table's size are actually copied, and this is the value returned. If offset > the table's size, or tag is not a valid table, then 0 is returned.

Definition at line 313 of file SkTypeface.cpp.

                                                  {
    return this->onGetTableData(tag, offset, length, data);
}

◆ getTableSize()

size_t SkTypeface::getTableSize ( SkFontTableTag tag ) const

Given a table tag, return the size of its contents, or 0 if not present

Definition at line 309 of file SkTypeface.cpp.

                                                        {
    return this->onGetTableData(tag, 0, ~0U, nullptr);
}

◆ getTableTags()

int SkTypeface::getTableTags ( SkFontTableTag tags[] ) const

Copy into tags[] (allocated by the caller) the list of table tags in the font, and return the number. This will be the same as CountTables() or 0 if an error occured. If tags == NULL, this only returns the count (the same as calling countTables()).

Definition at line 305 of file SkTypeface.cpp.

                                                        {
    return this->onGetTableTags(tags);
}

◆ getUnitsPerEm()

int SkTypeface::getUnitsPerEm ( ) const

Return the units-per-em value for this typeface, or zero if there is an error.

Definition at line 436 of file SkTypeface.cpp.

                                    {
    // should we try to cache this in the base-class?
    return this->onGetUPEM();
}

◆ getVariationDesignParameters()

int SkTypeface::getVariationDesignParameters	(	SkFontParameters::Variation::Axis	parameters[],
		int	parameterCount
	)		const

Copy into 'parameters' (allocated by the caller) the design variation parameters.

Parameters

parameters	the buffer into which to write the design variation parameters.
coordinateCount	the number of entries available through 'parameters'.

Returns: The number of axes, or -1 if there is an error. If 'parameters != nullptr' and 'parameterCount >= numAxes' then 'parameters' will be filled with the variation parameters describing the position of this typeface in design variation space. It is possible the number of axes can be retrieved but actual parameters cannot.

Definition at line 295 of file SkTypeface.cpp.

{
    return this->onGetVariationDesignParameters(parameters, parameterCount);
}

◆ getVariationDesignPosition()

int SkTypeface::getVariationDesignPosition	(	SkFontArguments::VariationPosition::Coordinate	coordinates[],
		int	coordinateCount
	)		const

Copy into 'coordinates' (allocated by the caller) the design variation coordinates.

Parameters

coordinates	the buffer into which to write the design variation coordinates.
coordinateCount	the number of entries available through 'coordinates'.

Returns: The number of axes, or -1 if there is an error. If 'coordinates != nullptr' and 'coordinateCount >= numAxes' then 'coordinates' will be filled with the variation coordinates describing the position of this typeface in design variation space. It is possible the number of axes can be retrieved but actual position cannot.

Definition at line 289 of file SkTypeface.cpp.

{
    return this->onGetVariationDesignPosition(coordinates, coordinateCount);
}

◆ internal_private_getCTFontRef()

void * SkTypeface::internal_private_getCTFontRef ( ) const

inline

Definition at line 330 of file SkTypeface.h.

                                                {
        return this->onGetCTFontRef();
    }

◆ isBold()

bool SkTypeface::isBold ( ) const

inline

Returns true if style() has the kBold bit set.

Definition at line 60 of file SkTypeface.h.

60{ return fStyle.weight() >= SkFontStyle::kSemiBold_Weight; }

SkFontStyle::kSemiBold_Weight

@ kSemiBold_Weight

Definition: SkFontStyle.h:25

SkFontStyle::weight

int weight() const

Definition: SkFontStyle.h:62

◆ isFixedPitch()

bool SkTypeface::isFixedPitch ( ) const

inline

Returns true if the typeface claims to be fixed-pitch. This is a style bit, advance widths may vary even if this returns true.

Definition at line 68 of file SkTypeface.h.

68{ return fIsFixedPitch; }

◆ isItalic()

bool SkTypeface::isItalic ( ) const

inline

Returns true if style() has the kItalic bit set.

Definition at line 63 of file SkTypeface.h.

63{ return fStyle.slant() != SkFontStyle::kUpright_Slant; }

SkFontStyle::slant

Slant slant() const

Definition: SkFontStyle.h:64

SkFontStyle::kUpright_Slant

@ kUpright_Slant

Definition: SkFontStyle.h:45

◆ makeClone()

sk_sp< SkTypeface > SkTypeface::makeClone ( const SkFontArguments & args ) const

Return a new typeface based on this typeface but parameterized as specified in the SkFontArguments. If the SkFontArguments does not supply an argument for a parameter in the font then the value from this typeface will be used as the value for that argument. If the cloned typeface would be exaclty the same as this typeface then this typeface may be ref'ed and returned. May return nullptr on failure.

Definition at line 190 of file SkTypeface.cpp.

                                                                         {
    return this->onMakeClone(args);
}

◆ MakeDeserialize()

sk_sp< SkTypeface > SkTypeface::MakeDeserialize	(	SkStream *	stream,
		sk_sp< SkFontMgr >	lastResortMgr
	)

static

Given the data previously written by serialize(), return a new instance of a typeface referring to the same font. If that font is not available, return nullptr. Goes through all registered typeface factories and lastResortMgr (if non-null). Does not affect ownership of SkStream.

Definition at line 241 of file SkTypeface.cpp.

                                                                                              {
    SkFontDescriptor desc;
    if (!SkFontDescriptor::Deserialize(stream, &desc)) {
        return nullptr;
    }
 
    if (desc.hasStream()) {
        for (const DecoderProc& proc : *decoders()) {
            if (proc.id == desc.getFactoryId()) {
                return proc.makeFromStream(desc.detachStream(), desc.getFontArguments());
            }
        }
 
        [[maybe_unused]] FactoryId id = desc.getFactoryId();
        SkDEBUGF("Could not find factory %c%c%c%c for %s.\n",
                 (char)((id >> 24) & 0xFF),
                 (char)((id >> 16) & 0xFF),
                 (char)((id >> 8) & 0xFF),
                 (char)((id >> 0) & 0xFF),
                 desc.getFamilyName());
 
        if (lastResortMgr) {
            // If we've gotten to here, we will try desperately to find something that might match
            // as a kind of last ditch effort to make something work (and maybe this SkFontMgr knows
            // something about the serialization and can look up the right thing by name anyway if
            // the user provides it).
            // Any time it is used the user will probably get the wrong glyphs drawn (and if they're
            // right it is totally by accident). But sometimes drawing something or getting lucky
            // while debugging is better than drawing nothing at all.
            sk_sp<SkTypeface> typeface = lastResortMgr->makeFromStream(desc.detachStream(),
                                                                       desc.getFontArguments());
            if (typeface) {
                return typeface;
            }
        }
    }
    if (lastResortMgr) {
        return lastResortMgr->legacyMakeTypeface(desc.getFamilyName(), desc.getStyle());
    }
    return SkEmptyTypeface::Make();
}

◆ MakeEmpty()

sk_sp< SkTypeface > SkTypeface::MakeEmpty ( )

static

Returns a non-null typeface which contains no glyphs.

Definition at line 145 of file SkTypeface.cpp.

                                        {
    return SkEmptyTypeface::Make();
}

◆ onCharsToGlyphs()

virtual void SkTypeface::onCharsToGlyphs	(	const SkUnichar *	chars,
		int	count,
		SkGlyphID	glyphs[]
	)		const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onComputeBounds()

bool SkTypeface::onComputeBounds ( SkRect * bounds ) const

protectedvirtual

Definition at line 516 of file SkTypeface.cpp.

                                                     {
    // we use a big size to ensure lots of significant bits from the scalercontext.
    // then we scale back down to return our final answer (at 1-pt)
    const SkScalar textSize = 2048;
    const SkScalar invTextSize = 1 / textSize;
 
    SkFont font;
    font.setTypeface(sk_ref_sp(const_cast<SkTypeface*>(this)));
    font.setSize(textSize);
    font.setLinearMetrics(true);
 
    SkScalerContextRec rec;
    SkScalerContextEffects effects;
 
    SkScalerContext::MakeRecAndEffectsFromFont(font, &rec, &effects);
 
    SkAutoDescriptor ad;
    SkScalerContextEffects noeffects;
    SkScalerContext::AutoDescriptorGivenRecAndEffects(rec, noeffects, &ad);
 
    std::unique_ptr<SkScalerContext> ctx = this->createScalerContext(noeffects, ad.getDesc());
 
    SkFontMetrics fm;
    ctx->getFontMetrics(&fm);
    if (!fm.hasBounds()) {
        return false;
    }
    bounds->setLTRB(fm.fXMin * invTextSize, fm.fTop * invTextSize,
                    fm.fXMax * invTextSize, fm.fBottom * invTextSize);
    return true;
}

◆ onCopyTableData()

sk_sp< SkData > SkTypeface::onCopyTableData ( SkFontTableTag tag ) const

protectedvirtual

Reimplemented in SkTypeface_FreeType, and DWriteFontTypeface.

Definition at line 322 of file SkTypeface.cpp.

                                                                  {
    size_t size = this->getTableSize(tag);
    if (size) {
        sk_sp<SkData> data = SkData::MakeUninitialized(size);
        (void)this->getTableData(tag, 0, size, data->writable_data());
        return data;
    }
    return nullptr;
}

◆ onCountGlyphs()

virtual int SkTypeface::onCountGlyphs ( ) const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onCreateFamilyNameIterator()

virtual LocalizedStrings * SkTypeface::onCreateFamilyNameIterator ( ) const

protectedpure virtual

Returns an iterator over the family names in the font.

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onCreateScalerContext()

virtual std::unique_ptr< SkScalerContext > SkTypeface::onCreateScalerContext	(	const SkScalerContextEffects &	,
		const SkDescriptor *
	)		const

protectedpure virtual

Implemented in SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestTypeface, SkTypefaceProxy, SkTypeface_Fontations, and TestEmptyTypeface.

◆ onFilterRec()

virtual void SkTypeface::onFilterRec ( SkScalerContextRec * ) const

protectedpure virtual

Implemented in SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, SkTypefaceProxy, SkTypeface_fontconfig, and TestTypeface.

◆ onGetAdvancedMetrics()

virtual std::unique_ptr< SkAdvancedTypefaceMetrics > SkTypeface::onGetAdvancedMetrics ( ) const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_fontconfig, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onGetCTFontRef()

virtual void * SkTypeface::onGetCTFontRef ( ) const

inlineprotectedvirtual

Reimplemented in SkTypefaceProxy.

Definition at line 407 of file SkTypeface.h.

407{ return nullptr; }

◆ onGetFamilyName()

virtual void SkTypeface::onGetFamilyName ( SkString * familyName ) const

protectedpure virtual

Returns the family name of the typeface as known by its font manager. This name may or may not be produced by the family name iterator.

Implemented in SkTypefaceProxy, SkTypeface_FCI, SkTypeface_Custom, SkTypeface_fontconfig, SkTypeface_Fontations, SkTypeface_FreeTypeStream, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onGetFontDescriptor()

virtual void SkTypeface::onGetFontDescriptor	(	SkFontDescriptor *	,
		bool *	isLocal
	)		const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_FCI, SkTypeface_Fontations, DWriteFontTypeface, TestEmptyTypeface, SkRandomTypeface, SkTypeface_FreeTypeStream, SkTypeface_Custom, SkTypeface_fontconfig, and TestTypeface.

◆ onGetKerningPairAdjustments()

bool SkTypeface::onGetKerningPairAdjustments	(	const SkGlyphID	glyphs[],
		int	count,
		int32_t	adjustments[]
	)		const

protectedvirtual

Reimplemented in SkTypeface_FreeType.

Definition at line 496 of file SkTypeface.cpp.

                                                                          {
    return false;
}

◆ onGetPostScriptName()

virtual bool SkTypeface::onGetPostScriptName ( SkString * ) const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onGetTableData()

virtual size_t SkTypeface::onGetTableData	(	SkFontTableTag	,
		size_t	offset,
		size_t	length,
		void *	data
	)		const

protectedpure virtual

Implemented in TestTypeface, SkTypefaceProxy, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, SkTypeface_Fontations, and TestEmptyTypeface.

◆ onGetTableTags()

virtual int SkTypeface::onGetTableTags ( SkFontTableTag tags[] ) const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onGetUPEM()

virtual int SkTypeface::onGetUPEM ( ) const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onGetVariationDesignParameters()

virtual int SkTypeface::onGetVariationDesignParameters	(	SkFontParameters::Variation::Axis	parameters[],
		int	parameterCount
	)		const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onGetVariationDesignPosition()

virtual int SkTypeface::onGetVariationDesignPosition	(	SkFontArguments::VariationPosition::Coordinate	coordinates[],
		int	coordinateCount
	)		const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onGlyphMaskNeedsCurrentColor()

virtual bool SkTypeface::onGlyphMaskNeedsCurrentColor ( ) const

protectedpure virtual

Implemented in SkTypefaceProxy, SkTypeface_Fontations, SkTypeface_FreeType, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onMakeClone()

virtual sk_sp< SkTypeface > SkTypeface::onMakeClone ( const SkFontArguments & ) const

protectedpure virtual

Implemented in SkTypeface_FreeTypeStream, DWriteFontTypeface, SkTypefaceProxy, SkTypeface_FCI, SkTypeface_Empty, SkTypeface_File, SkTypeface_fontconfig, SkTypeface_Fontations, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ onOpenExistingStream()

std::unique_ptr< SkStreamAsset > SkTypeface::onOpenExistingStream ( int * ttcIndex ) const

protectedvirtual

Definition at line 501 of file SkTypeface.cpp.

                                                                                 {
    return this->onOpenStream(ttcIndex);
}

◆ onOpenStream()

virtual std::unique_ptr< SkStreamAsset > SkTypeface::onOpenStream ( int * ttcIndex ) const

protectedpure virtual

Implemented in SkTypeface_Empty, SkTypefaceProxy, SkTypeface_FCI, SkTypeface_File, SkTypeface_fontconfig, SkTypeface_Fontations, SkTypeface_FreeTypeStream, DWriteFontTypeface, SkRandomTypeface, TestEmptyTypeface, and TestTypeface.

◆ openExistingStream()

std::unique_ptr< SkStreamAsset > SkTypeface::openExistingStream ( int * ttcIndex ) const

Return a stream for the contents of the font data. Returns nullptr on failure or if the font data isn't already available in stream form. Use when the stream can be used opportunistically but the calling code would prefer to fall back to table access if creating the stream would be expensive. Otherwise acts the same as openStream.

Definition at line 341 of file SkTypeface.cpp.

                                                                               {
    int ttcIndexStorage;
    if (nullptr == ttcIndex) {
        // So our subclasses don't need to check for null param
        ttcIndex = &ttcIndexStorage;
    }
    return this->onOpenExistingStream(ttcIndex);
}

◆ openStream()

std::unique_ptr< SkStreamAsset > SkTypeface::openStream ( int * ttcIndex ) const

Return a stream for the contents of the font data, or NULL on failure. If ttcIndex is not null, it is set to the TrueTypeCollection index of this typeface within the stream, or 0 if the stream is not a collection. The caller is responsible for deleting the stream.

Definition at line 332 of file SkTypeface.cpp.

                                                                       {
    int ttcIndexStorage;
    if (nullptr == ttcIndex) {
        // So our subclasses don't need to check for null param
        ttcIndex = &ttcIndexStorage;
    }
    return this->onOpenStream(ttcIndex);
}

◆ Register()

void SkTypeface::Register	(	FactoryId	id,
		sk_sp< SkTypeface >(*)(std::unique_ptr< SkStreamAsset >, const SkFontArguments &)	make
	)

static

Definition at line 196 of file SkTypeface.cpp.

                                                                                             {
    decoders()->push_back(DecoderProc{id, make});
}

◆ serialize() [1/2]

sk_sp< SkData > SkTypeface::serialize ( SerializeBehavior behavior = SerializeBehavior::kIncludeDataIfLocal ) const

Same as serialize(SkWStream*, ...) but returns the serialized data in SkData, instead of writing it to a stream.

Definition at line 235 of file SkTypeface.cpp.

                                                                    {
    SkDynamicMemoryWStream stream;
    this->serialize(&stream, behavior);
    return stream.detachAsData();
}

◆ serialize() [2/2]

void SkTypeface::serialize	(	SkWStream *	wstream,
		SerializeBehavior	behavior = `SerializeBehavior::kIncludeDataIfLocal`
	)		const

Write a unique signature to a stream, sufficient to reconstruct a typeface referencing the same font when Deserialize is called.

Definition at line 202 of file SkTypeface.cpp.

                                                                               {
    bool isLocalData = false;
    SkFontDescriptor desc;
    this->onGetFontDescriptor(&desc, &isLocalData);
    if (desc.getFactoryId() == 0) {
        SkDEBUGF("Factory was not set for %s.\n", desc.getFamilyName());
    }
 
    bool shouldSerializeData = false;
    switch (behavior) {
        case SerializeBehavior::kDoIncludeData:      shouldSerializeData = true;        break;
        case SerializeBehavior::kDontIncludeData:    shouldSerializeData = false;       break;
        case SerializeBehavior::kIncludeDataIfLocal: shouldSerializeData = isLocalData; break;
    }
 
    if (shouldSerializeData) {
        int index;
        desc.setStream(this->openStream(&index));
        if (desc.hasStream()) {
            desc.setCollectionIndex(index);
        }
 
        int numAxes = this->getVariationDesignPosition(nullptr, 0);
        if (0 < numAxes) {
            numAxes = this->getVariationDesignPosition(desc.setVariationCoordinates(numAxes), numAxes);
            if (numAxes <= 0) {
                desc.setVariationCoordinates(0);
            }
        }
    }
    desc.serialize(wstream);
}

◆ setFontStyle()

void SkTypeface::setFontStyle ( SkFontStyle style )

inlineprotected

Sets the font style. If used, must be called in the constructor.

Definition at line 349 of file SkTypeface.h.

349{ fStyle = style; }

◆ setIsFixedPitch()

void SkTypeface::setIsFixedPitch ( bool isFixedPitch )

inlineprotected

Sets the fixedPitch bit. If used, must be called in the constructor.

Definition at line 347 of file SkTypeface.h.

347{ fIsFixedPitch = isFixedPitch; }

◆ textToGlyphs()

int SkTypeface::textToGlyphs	(	const void *	text,
		size_t	byteLength,
		SkTextEncoding	encoding,
		SkGlyphID	glyphs[],
		int	maxGlyphCount
	)		const

Definition at line 407 of file SkTypeface.cpp.

                                                                          {
    if (0 == byteLength) {
        return 0;
    }
 
    SkASSERT(text);
 
    int count = SkFontPriv::CountTextElements(text, byteLength, encoding);
    if (!glyphs || count > maxGlyphCount) {
        return count;
    }
 
    if (encoding == SkTextEncoding::kGlyphID) {
        memcpy(glyphs, text, count << 1);
        return count;
    }
 
    SkConvertToUTF32 storage;
    const SkUnichar* uni = storage.convert(text, byteLength, encoding);
 
    this->unicharsToGlyphs(uni, count, glyphs);
    return count;
}

◆ unicharsToGlyphs()

void SkTypeface::unicharsToGlyphs	(	const SkUnichar	uni[],
		int	count,
		SkGlyphID	glyphs[]
	)		const

Given an array of UTF32 character codes, return their corresponding glyph IDs.

Parameters

chars	pointer to the array of UTF32 chars
number	of chars and glyphs
glyphs	returns the corresponding glyph IDs for each character.

Definition at line 357 of file SkTypeface.cpp.

                                                                                            {
    if (count > 0 && glyphs && uni) {
        this->onCharsToGlyphs(uni, count, glyphs);
    }
}

◆ unicharToGlyph()

SkGlyphID SkTypeface::unicharToGlyph ( SkUnichar unichar ) const

Return the glyphID that corresponds to the specified unicode code-point (in UTF32 encoding). If the unichar is not supported, returns 0.

This is a short-cut for calling unicharsToGlyphs().

Definition at line 363 of file SkTypeface.cpp.

                                                        {
    SkGlyphID glyphs[1] = { 0 };
    this->onCharsToGlyphs(&uni, 1, glyphs);
    return glyphs[0];
}

◆ uniqueID()

SkTypefaceID SkTypeface::uniqueID ( ) const

inline

Return a 32bit value for this typeface, unique for the underlying font data. Will never return 0.

Definition at line 101 of file SkTypeface.h.

101{ return fUniqueID; }

Friends And Related Function Documentation

◆ SkFontPriv

friend class SkFontPriv

friend

Definition at line 423 of file SkTypeface.h.

◆ SkPDFFont

friend class SkPDFFont

friend

Definition at line 421 of file SkTypeface.h.

◆ SkRandomTypeface

friend class SkRandomTypeface

friend

Definition at line 420 of file SkTypeface.h.

◆ SkScalerContext

friend class SkScalerContext

friend

Definition at line 355 of file SkTypeface.h.

◆ SkStrikeServerImpl

friend class SkStrikeServerImpl

friend

Definition at line 415 of file SkTypeface.h.

◆ SkTypefaceProxyPrototype

friend class SkTypefaceProxyPrototype

friend

Definition at line 416 of file SkTypeface.h.

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

third_party/skia/include/core/SkTypeface.h
third_party/skia/src/core/SkTypeface.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ FactoryId

Member Enumeration Documentation

◆ SerializeBehavior

Constructor & Destructor Documentation

◆ SkTypeface()

◆ ~SkTypeface()

Member Function Documentation

◆ copyTableData()

◆ countGlyphs()

◆ countTables()

◆ createFamilyNameIterator()

◆ createScalerContext()

◆ Equal()

◆ filterRec()

◆ fontStyle()

◆ getBounds()

◆ getFamilyName()

◆ getFontDescriptor()

◆ getGlyphToUnicodeMap()

◆ getKerningPairAdjustments()

◆ getPostScriptGlyphNames()

◆ getPostScriptName()

◆ getTableData()

◆ getTableSize()

◆ getTableTags()

◆ getUnitsPerEm()

◆ getVariationDesignParameters()

◆ getVariationDesignPosition()

◆ internal_private_getCTFontRef()

◆ isBold()

◆ isFixedPitch()

◆ isItalic()

◆ makeClone()

◆ MakeDeserialize()

◆ MakeEmpty()

◆ onCharsToGlyphs()

◆ onComputeBounds()

◆ onCopyTableData()

◆ onCountGlyphs()

◆ onCreateFamilyNameIterator()

◆ onCreateScalerContext()

◆ onFilterRec()

◆ onGetAdvancedMetrics()

◆ onGetCTFontRef()

◆ onGetFamilyName()

◆ onGetFontDescriptor()

◆ onGetKerningPairAdjustments()

◆ onGetPostScriptName()

◆ onGetTableData()

◆ onGetTableTags()

◆ onGetUPEM()

◆ onGetVariationDesignParameters()

◆ onGetVariationDesignPosition()

◆ onGlyphMaskNeedsCurrentColor()

◆ onMakeClone()

◆ onOpenExistingStream()

◆ onOpenStream()

◆ openExistingStream()

◆ openStream()

◆ Register()

◆ serialize() [1/2]

◆ serialize() [2/2]

◆ setFontStyle()

◆ setIsFixedPitch()

◆ textToGlyphs()

◆ unicharsToGlyphs()

◆ unicharToGlyph()

◆ uniqueID()

Friends And Related Function Documentation

◆ SkFontPriv

◆ SkPDFFont

◆ SkRandomTypeface