Framework
GlyphsCore
The Core API, usable from Objective-C, Swift, and Python.
Overview
This is the API documentation for the classes used in Glyphs.
Topics
Essentials
The top-level model object of a Glyphs document.
A named glyph and its layer collection in a font.
The drawing and editing representation of a glyph.
GSAxisrepresents an axis in aGSFontobject.
Shapes
An abstract base class for graphical elements stored in a glyph layer.
A graphical path made of nodes.
A reference to another glyph placed as a shape in a glyph layer.
A shape group combines zero or more shapes into a single shape, forming a shape tree.
Layout Features
A snippet of feature code.
The class defining the Prefix object
The class represents the OpenType classes
The class defining the feature object
Concepts
A resolved combination of character and line directions.
Pens
Geometry
Property List
Serialization
Utilities
Constants
Articles
Drawing the contents of a layer can be done for different output formats. These include black-and-white vector outlines (TrueType glif), color vector (OpenType COLR), bitmap graphics (PNG), and mixed formats that can hold both vector and bitmap graphics (SVG, PDF).
Classes
This class defines an alignment zone, which conforms to the GSItemProtocol.
The class implementing the properties in Smart Glyphs.
The abstract base class for objects positioned on a layer.
Uses a C++ std::map collection internally.
A color line is a sorted collection of color stops used to describe a gradient.
The abstract base class for positioned elements.
Generates the OT features for the Font.
GSGlyphInfo: The class defining the glyphInfo object This class defines the glyphInfo object.
GSBackgroundImage: The class defining the image
A reimplementation of Swift’s
NSKeyValueObservation, usable from Objective-C and using string key paths.metrics value entry
A pen that does nothing except fulfill the pen protocol.
A color that references a base color from a color palette and multiplies the alpha component with an additional factor.
This class defines the palettes object which conforms to the GSItemProtocol and NSCopying.
A radial (circular/angular) gradient.
/// /// ////// ////// ////// ////// ////// ////// //
Protocols
A common interface for positioned objects that can participate in layer editing and selection.
An interface for storing persistent data associated with a model object.
The protocol defining the filter plugin interface
Structures
Compositing operation, documented with the OpenType, Core Graphics, and NSGraphics constants.
Common categories/subCategories
Flags controlling which associated data is included when copying fonts, glyphs, and layers.
State flags for metrics key display.
A key identifying a font information property.
Options that control the data written while saving Glyphs source data.
Variables
Functions
Type Aliases
Enumerations
The Type of the annotation
The case classification of a glyph.
A placement or fitting option for attaching a corner or cap component to a path.
The style of the default figure glyphs in a font.
A version of the Glyphs source format.
Hint types
Enum defining the types of instances.
An outline format used to export a static or variable OpenType font.
The storage layout of a Glyphs source file.
Extended Modules
Other
The display size of handles used to edit graphical elements.
A side of a node along a path.
Enumeration defining palette attributes.
Topics
Essentials
The top-level model object of a Glyphs document.
A named glyph and its layer collection in a font.
The drawing and editing representation of a glyph.
GSAxisrepresents an axis in aGSFontobject.
Shapes
An abstract base class for graphical elements stored in a glyph layer.
A graphical path made of nodes.
A reference to another glyph placed as a shape in a glyph layer.
A shape group combines zero or more shapes into a single shape, forming a shape tree.
Layout Features
A snippet of feature code.
The class defining the Prefix object
The class represents the OpenType classes
The class defining the feature object
Concepts
A resolved combination of character and line directions.
Pens
Geometry
Property List
Serialization
Utilities
Constants
Articles
Drawing the contents of a layer can be done for different output formats. These include black-and-white vector outlines (TrueType glif), color vector (OpenType COLR), bitmap graphics (PNG), and mixed formats that can hold both vector and bitmap graphics (SVG, PDF).
Classes
This class defines an alignment zone, which conforms to the GSItemProtocol.
The class implementing the properties in Smart Glyphs.
The abstract base class for objects positioned on a layer.
Uses a C++ std::map collection internally.
A color line is a sorted collection of color stops used to describe a gradient.
The abstract base class for positioned elements.
Generates the OT features for the Font.
GSGlyphInfo: The class defining the glyphInfo object This class defines the glyphInfo object.
GSBackgroundImage: The class defining the image
A reimplementation of Swift’s
NSKeyValueObservation, usable from Objective-C and using string key paths.metrics value entry
A pen that does nothing except fulfill the pen protocol.
A color that references a base color from a color palette and multiplies the alpha component with an additional factor.
This class defines the palettes object which conforms to the GSItemProtocol and NSCopying.
A radial (circular/angular) gradient.
/// /// ////// ////// ////// ////// ////// ////// //
Protocols
A common interface for positioned objects that can participate in layer editing and selection.
An interface for storing persistent data associated with a model object.
The protocol defining the filter plugin interface
Structures
Functions
Macros
Type Aliases
Maps axis ids to metric values.
Compositing operation, documented with the OpenType, Core Graphics, and NSGraphics constants.
Common categories/subCategories
A key identifying a font information property.
Enumerations
The Type of the annotation
The case classification of a glyph.
A placement or fitting option for attaching a corner or cap component to a path.
The style of the default figure glyphs in a font.
A version of the Glyphs source format.
Flags controlling which associated data is included when copying fonts, glyphs, and layers.
The display size of handles used to edit graphical elements.
Hint types
Enum defining the types of instances.
State flags for metrics key display.
A side of a node along a path.
An outline format used to export a static or variable OpenType font.
The storage layout of a Glyphs source file.
Enumeration defining palette attributes.
Options that control the data written while saving Glyphs source data.