Typeface

public class Typeface

The Typeface class specifies the typeface and intrinsic style of a font. This is used in the renderer, along with optionally Renderer settings like typeSize, slantAngle, scaleX, to specify how text appears when drawn (and measured).

Show on GitHub

  • Creates a typeface from the specified file. The data for the font is directly read from the file when needed.

    Declaration

    Swift

    public init?(path: String)

    Parameters

    path

    The path of the font file.
    Show on GitHub

  • Creates a new typeface from the data of the font.

    Declaration

    Swift

    public init?(data: Data)

    Parameters

    data

    The data of the font.
    Show on GitHub

  • Creates a new typeface from the input stream by copying its data into a memory buffer. It may take some time to create the typeface if the stream holds larger data.

    Declaration

    Swift

    public init?(stream: InputStream)

    Parameters

    stream

    The input stream that contains the data of the font.
    Show on GitHub

  • A Boolean value that indicates whether the typeface supports OpenType font variations.

    Declaration

    Swift

    public var isVariable: Bool { get }
    Show on GitHub

  • Returns a variation instance of this typeface with the specified design coordinates.

    Declaration

    Swift

    public func variationInstance(forCoordinates coordinates: [CGFloat]) -> Typeface?

    Parameters

    coordinates

    The variation design coordinates.

    Return Value

    A variation instance of this typeface with the specified design coordinates.

    Show on GitHub

  • The variation axes of this typeface.

    Declaration

    Swift

    public var variationAxes: [VariationAxis] { get }
    Show on GitHub

  • The named instance records of this typeface.

    Declaration

    Swift

    public var namedStyles: [NamedStyle] { get }
    Show on GitHub

  • The design variation coordinates of this typeface.

    Declaration

    Swift

    public var variationCoordinates: [CGFloat] { get }
    Show on GitHub

  • The names associated with palette entries if this typeface supports OpenType color palettes.

    Declaration

    Swift

    public var paletteEntryNames: [String] { get }
    Show on GitHub

  • The predefined palettes in this typeface if it supports OpenType color palettes.

    Declaration

    Swift

    public var predefinedPalettes: [ColorPalette] { get }
    Show on GitHub

  • The colors associated with this typeface if it supports OpenType color palettes.

    Declaration

    Swift

    public var associatedColors: [UIColor] { get }
    Show on GitHub

  • Returns a color instance of this typeface with the specified colors array.

    Declaration

    Swift

    public func colorInstance(forColors colors: [UIColor]) -> Typeface?

    Parameters

    colors

    The colors array.

    Return Value

    A color instance of this typeface with the specified colors array.

    Show on GitHub

  • The family name of this typeface.

    Declaration

    Swift

    public var familyName: String { get }
    Show on GitHub

  • The style name of this typeface.

    Declaration

    Swift

    public var styleName: String { get }
    Show on GitHub

  • The full name of this typeface.

    Declaration

    Swift

    public var fullName: String { get }
    Show on GitHub

  • The typographic weight of this typeface. The weight value determines the thickness associated with a given character in a typeface.

    Declaration

    Swift

    public var weight: Weight { get }
    Show on GitHub

  • The typographic width of this typeface. The width value determines whether a typeface is expanded or condensed when it is displayed.

    Declaration

    Swift

    public var width: Width { get }
    Show on GitHub

  • The typographic slope of this typeface. The slope value determines whether a typeface is plain or slanted when it is displayed.

    Declaration

    Swift

    public var slope: Slope { get }
    Show on GitHub

  • The number of font units per EM square for this typeface.

    Declaration

    Swift

    public var unitsPerEm: Int { get }
    Show on GitHub

  • The typographic ascender of this typeface expressed in font units.

    Declaration

    Swift

    public var ascent: Int { get }
    Show on GitHub

  • The typographic descender of this typeface expressed in font units.

    Declaration

    Swift

    public var descent: Int { get }
    Show on GitHub

  • The typographic leading of this typeface expressed in font units.

    Declaration

    Swift

    public var leading: Int { get }
    Show on GitHub

  • The number of glyphs in this typeface.

    Declaration

    Swift

    public var glyphCount: Int { get }
    Show on GitHub

  • The font bounding box expressed in font units. The box is large enough to contain any glyph from the font.

    Declaration

    Swift

    public var boundingBox: CGRect { get }
    Show on GitHub

  • The position, in font units, of the underline for this typeface.

    Declaration

    Swift

    public var underlinePosition: Int { get }
    Show on GitHub

  • The thickness, in font units, of the underline for this typeface.

    Declaration

    Swift

    public var underlineThickness: Int { get }
    Show on GitHub

  • The position, in font units, of the strikeout for this typeface.

    Declaration

    Swift

    public var strikeoutPosition: Int { get }
    Show on GitHub

  • The thickness, in font units, of the strikeout for this typeface.

    Declaration

    Swift

    public var strikeoutThickness: Int { get }
    Show on GitHub

  • Returns the data of the table specified by the tag.

    Declaration

    Swift

    public func dataOfTable(_ tag: SFNTTag) -> Data?

    Parameters

    tag

    The tag of the table.

    Return Value

    The data of the intended table, or nil if no such table exists.

    Show on GitHub

  • Returns the glyph id for the specified code point.

    Declaration

    Swift

    public func glyphID(forCodePoint codePoint: UTF32Char) -> GlyphID

    Parameters

    codePoint

    The code point for which the glyph id is obtained.

    Return Value

    The glyph id for the specified code point.

    Show on GitHub

  • Retrieves the advance for the specified glyph.

    Declaration

    Swift

    public func advance(forGlyph glyphID: GlyphID, typeSize: CGFloat, vertical: Bool) -> CGFloat

    Parameters

    glyphID

    The glyph id for which to retrieve the advance.
    typeSize

    The size for which the advance is retrieved.
    vertical

    The flag which indicates the type of advance, either horizontal or vertical.

    Return Value

    The advance for the specified glyph.

    Show on GitHub

  • Generates the path for the specified glyph.

    Declaration

    Swift

    public func path(forGlyph glyphID: GlyphID, typeSize: CGFloat, transform: CGAffineTransform?) -> CGPath?

    Parameters

    glyphID

    The glyph id for which the path is generated.
    typeSize

    The size for which the glyph path is required.
    transform

    The transform applied to the path. Can be nil if no transformation is required.

    Return Value

    The path for the specified glyph.

    Show on GitHub

  • Specifies the slope of a typeface.

    See more

    Declaration

    Swift

    public enum Slope : Int
    Show on GitHub

  • Specifies the thickness of a typeface, in terms of lightness or heaviness of the strokes.

    See more

    Declaration

    Swift

    public enum Weight : Int
    Show on GitHub

  • Specifies the wideness of a typeface, in terms of the width of characters in relation to their heights.

    See more

    Declaration

    Swift

    public enum Width : Int
    Show on GitHub