About

Terminal images in the Mys programming language.

Project: https://github.com/mys-lang/package-tim

Installation

❯ mys install tim

Usage

API

tim.terminal

enum GraphicsProtocol(i64):
    Kitty
    ITerm
    Sixel
    Text

enum KittyTransmissionMedium(i64):
    Direct
    SimpleFile
    TemporaryFile
    SharedMemory

class Dimensions:
    width: i64
    height: i64

class Size:
    cells: Dimensions
    pixels: Dimensions?
    cell_pixels: Dimensions?

class KittyGraphicsInfo:
    is_supported: bool
    transmission_mediums: [KittyTransmissionMedium]

class SixelGraphicsInfo:
    is_supported: bool

class ITermGraphicsInfo:
    is_supported: bool

class GraphicsInfo:
    has_true_color: bool
    sixel: SixelGraphicsInfo
    kitty: KittyGraphicsInfo
    iterm: ITermGraphicsInfo

class Info:
    size: Size
    graphics: GraphicsInfo

func get_size() -> Size:
    Get terminal size.

func get_graphics_info() -> GraphicsInfo:
    Get graphics info.

func get_sixel_graphics_info() -> SixelGraphicsInfo:
    Get Sixel graphics info.

func get_kitty_graphics_info() -> KittyGraphicsInfo:
    Get Kitty graphics info.

func get_iterm_graphics_info() -> ITermGraphicsInfo:
    Get iTerm graphics info.

func get_info() -> Info:
    Get terminal info.

func get_preferred_graphics_protocol() -> GraphicsProtocol:
    Get preferred graphics protocol.

tim.kitty

func write_png(image: bytes):
    Write given image to the terminal.

tim.iterm

func write(image: bytes):
    Write given image to the terminal.