Skip to content

class GlyphNode

  • supers: Node

Example:

assert.node_type("glyph", nil, {
  id = "glyph (29)",
  subtypes = {
    "unset (0)",
    "character (1)",
    "ligature (2)",
    "ghost (4)",
    "left (8)",
    "right (16)",
  },
  fields = {
    "prev (-1)",
    "next (0)",
    "id (1)",
    "subtype (2)",
    "attr (3)",
    "char (4)",
    "font (5)",
    "lang (6)",
    "left (7)",
    "right (8)",
    "uchyph (9)",
    "components (10)",
    "xoffset (11)",
    "yoffset (12)",
    "width (13)",
    "height (14)",
    "depth (15)",
    "expansion_factor (16)",
    "data (17)",
  },
})

Reference:

😱 Types incomplete or incorrect? 🙏 Please contribute!

fields

GlyphNode.subtype

GlyphNode.subtype : GlyphNodeSubtype

A bit field

GlyphNode.attr

GlyphNode.attr : Node {
    next: Node?,
    prev: Node?,
    id: integer,
    subtype: integer,
    head: Node?,
    attr: Node,
}

A list of attributes.

GlyphNode.char

GlyphNode.char : integer

The character index in the font.

GlyphNode.font

GlyphNode.font : integer

The font identifier.

GlyphNode.lang

GlyphNode.lang : integer

The language identifier.

GlyphNode.left

GlyphNode.left : integer

The frozen \lefthyphenmnin value.

GlyphNode.right

GlyphNode.right : integer

The frozen \righthyphenmnin value.

GlyphNode.uchyph

GlyphNode.uchyph : boolean

The frozen uchyph value.

GlyphNode.components

GlyphNode.components : Node {
    next: Node?,
    prev: Node?,
    id: integer,
    subtype: integer,
    head: Node?,
    attr: Node,
}

A Pointer to ligature components.

GlyphNode.xoffset

GlyphNode.xoffset : integer

A virtual displacement in horizontal direction.

GlyphNode.yoffset

GlyphNode.yoffset : integer

A virtual displacement in vertical direction.

GlyphNode.width

GlyphNode.width : integer

The (original) width of the character.

GlyphNode.height

GlyphNode.height : integer

The (original) height of the character.

GlyphNode.depth

GlyphNode.depth : integer

The (original) depth of the character.

GlyphNode.expansion_factor

GlyphNode.expansion_factor : integer

The to be applied expansion factor.

GlyphNode.data

GlyphNode.data : integer

A general purpose field for users (we had room for it).