Structures

The following structures are available globally.

  • This option set describes the character style for a cell, this includes information about the font to use as well as decorations on the text

    See more

    Declaration

    Swift

    public struct CharacterStyle : OptionSet, Hashable
  • Attribute contains the foreground and background color information for the invidual cells, as well as the character style of the cell (bold, underline, inverse) that the character should be drawn as.

    See more

    Declaration

    Swift

    public struct Attribute : Equatable, Hashable
  • TinyAtoms are 16-bit values that can be used to represent a string as a number you create them by calling TinyAtom.lookup (Any) and retrieve the value using the target property. They are used to store the urls and any additional parameter information in the OSC 8 scenario or to store binary blobs for images

    This is kept to 16 bits for now, so that we keep the CharData to less than 15 bytes it could in theory be changed to be 24 bits without much trouble

    See more

    Declaration

    Swift

    public struct TinyAtom
  • Stores a cell with both the character being displayed as well as the color attribute. This uses an Int32 to store the value, if the value can not be encoded as a single Unicode.Scalar, then an index is stored that is looked up in parallel, so that full grapheme clusters can be tracked.

    Use the getCharacter function to get the stored Character, and use the attribute property to retrieve the color and other character attributes. The width property contains the number of columns used by the Character stored in this CharData on the screen.

    It is possible to change the value of the stored character by calling the setValue method.

    See more

    Declaration

    Swift

    public struct CharData : CustomDebugStringConvertible
  • Configuration options for the terminal at startup, these values are only read at startup

    See more

    Declaration

    Swift

    public struct TerminalOptions