BLFont Class Reference

Font [C++ API].

Member Functions

Construction & Destruction

BLFont()

BLFont(BLFont&& other)

BLFont(const BLFont& other)

~BLFont()

Overloaded Operators

operator bool() const

BLFont& operator=(BLFont&& other)

BLFont& operator=(const BLFont& other)

bool operator==(const BLFont& other) const

bool operator!=(const BLFont& other) const

Common Functionality

BLResult reset()

void swap(BLFont& other)

BLResult assign(BLFont&& other)

BLResult assign(const BLFont& other)

bool isValid() const

bool empty() const

bool equals(const BLFontCore& other) const

Create Functionality

BLResult createFromFace(const BLFontFaceCore& face, float size)

BLResult createFromFace(const BLFontFaceCore& face, float size, const BLFontFeatureSettingsCore& featureSettings)

BLResult createFromFace(const BLFontFaceCore& face, float size, const BLFontFeatureSettingsCore& featureSettings, const BLFontVariationSettingsCore& variationSettings)

Accessors

BLFontFaceType faceType() const

BLFontFaceFlags faceFlags() const

float size() const

BLResult setSize(float size)

const BLFontFace& face() const

uint32_t weight() const

uint32_t stretch() const

uint32_t style() const

int unitsPerEm() const

const BLFontMatrix& matrix() const

const BLFontMetrics& metrics() const

const BLFontDesignMetrics& designMetrics() const

const BLFontFeatureSettings& featureSettings() const

BLResult setFeatureSettings(const BLFontFeatureSettingsCore& featureSettings)

BLResult resetFeatureSettings()

const BLFontVariationSettings& variationSettings() const

BLResult setVariationSettings(const BLFontVariationSettingsCore& variationSettings)

BLResult resetVariationSettings()

Glyphs & Text

BLResult shape(BLGlyphBufferCore& gb) const

BLResult mapTextToGlyphs(BLGlyphBufferCore& gb) const

BLResult mapTextToGlyphs(BLGlyphBufferCore& gb, BLGlyphMappingState& stateOut) const

BLResult positionGlyphs(BLGlyphBufferCore& gb) const

BLResult applyKerning(BLGlyphBufferCore& gb) const

BLResult applyGSub(BLGlyphBufferCore& gb, const BLBitArrayCore& lookups) const

BLResult applyGPos(BLGlyphBufferCore& gb, const BLBitArrayCore& lookups) const

BLResult getTextMetrics(BLGlyphBufferCore& gb, BLTextMetrics& out) const

BLResult getGlyphBounds(const uint32_t* glyphData, intptr_t glyphAdvance, BLBoxI* out, size_t count) const

BLResult getGlyphAdvances(const uint32_t* glyphData, intptr_t glyphAdvance, BLGlyphPlacement* out, size_t count) const

BLResult getGlyphOutlines(BLGlyphId glyphId, BLPathCore& out, BLPathSinkFunc sink = nullptr, void* userData = nullptr) const

BLResult getGlyphOutlines(BLGlyphId glyphId, const BLMatrix2D& userTransform, BLPathCore& out, BLPathSinkFunc sink = nullptr, void* userData = nullptr) const

BLResult getGlyphRunOutlines(const BLGlyphRun& glyphRun, BLPathCore& out, BLPathSinkFunc sink = nullptr, void* userData = nullptr) const

BLResult getGlyphRunOutlines(const BLGlyphRun& glyphRun, const BLMatrix2D& userTransform, BLPathCore& out, BLPathSinkFunc sink = nullptr, void* userData = nullptr) const

Additional Inherited Members

 Public Attributes inherited from BLObjectCore

BLObjectDetail _d

Member Function Documentation

bool BLFont::isValid() const

Tests whether the font is a valid instance.

bool BLFont::empty() const

Tests whether the font is empty, which is the same as !isValid().

BLResult BLFont::createFromFace(const BLFontFaceCore& face, float size)[1/3]

Creates a new font from the existing font face scaled to the given size.

BLResult BLFont::createFromFace(const BLFontFaceCore& face, float size, const BLFontFeatureSettingsCore& featureSettings)[2/3]

Creates a new font from the existing font face scaled to the given size.

This is an overloaded function that takes additional argument `featureSettings.

BLResult BLFont::createFromFace(const BLFontFaceCore& face, float size, const BLFontFeatureSettingsCore& featureSettings, const BLFontVariationSettingsCore& variationSettings)[3/3]

Creates a new font from the existing font face scaled to the given size.

This is an overloaded function that takes additional arguments, which are used to override font featureSettings and font variationSettings.

BLFontFaceType BLFont::faceType() const

Returns the type of the font's associated font face.

BLFontFaceFlags BLFont::faceFlags() const

Returns the flags of the font.

float BLFont::size() const

Returns the size of the font (as float).

BLResult BLFont::setSize(float size)

Sets the font size to size.

const BLFontFace& BLFont::face() const

Returns the font's associated font face.

Returns the same font face, which was passed to createFromFace().

uint32_t BLFont::weight() const

Returns the weight of the font.

uint32_t BLFont::stretch() const

Returns the stretch of the font.

uint32_t BLFont::style() const

Returns the style of the font.

int BLFont::unitsPerEm() const

Returns the "units per em" (UPEM) of the font's associated font face.

const BLFontMatrix& BLFont::matrix() const

Returns a 2x2 matrix of the font.

The returned BLFontMatrix is used to scale fonts from design units into user units. The matrix usually has a negative m11 member as fonts use a different coordinate system than Blend2D.

const BLFontMetrics& BLFont::metrics() const

Returns the scaled metrics of the font.

The returned metrics is a scale of design metrics that match the font size and its options.

const BLFontDesignMetrics& BLFont::designMetrics() const

Returns the design metrics of the font.

The returned metrics is compatible with the metrics of BLFontFace associated with this font.

const BLFontFeatureSettings& BLFont::featureSettings() const

Returns font feature settings.

BLResult BLFont::setFeatureSettings(const BLFontFeatureSettingsCore& featureSettings)

Sets font feature settings to featureSettings.

BLResult BLFont::resetFeatureSettings()

Resets font feature settings.

const BLFontVariationSettings& BLFont::variationSettings() const

Returns font variation settings.

BLResult BLFont::setVariationSettings(const BLFontVariationSettingsCore& variationSettings)

Sets font variation settings to variationSettings.

BLResult BLFont::resetVariationSettings()

Resets font variation settings.