nimterm/canvas

This page is generated from the module’s exported API and ## documentation comments.

Testable terminal-cell canvas.

Types

Cell

Cell = object
  glyph*: Rune
  combining*: string
  continuation*: bool
  style*: Style

View source

Canvas

Canvas = object
  size*: Size

View source

Procedures

blankCell

proc blankCell(style = defaultStyle()): Cell {.raises: [], tags: [], forbids: [].}

Returns: Cell.

Arguments

Name	Type	Default
style	inferred	defaultStyle()

View source

newCanvas

proc newCanvas(canvasSize: Size; fill = blankCell()): Canvas {.raises: [],
    tags: [], forbids: [].}

Returns: Canvas.

Arguments

Name	Type	Default
canvasSize	Size
fill	inferred	blankCell()

View source

valid

proc valid(canvas: Canvas; x, y: int): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
canvas	Canvas
x	int
y	int

View source

getCell

proc getCell(canvas: Canvas; x, y: int): Cell {.raises: [], tags: [],
    forbids: [].}

Returns: Cell.

Arguments

Name	Type	Default
canvas	Canvas
x	int
y	int

View source

setCell

proc setCell(canvas: var Canvas; x, y: int; cell: Cell) {.raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
canvas	var Canvas
x	int
y	int
cell	Cell

View source

clear

proc clear(canvas: var Canvas; fill = blankCell()) {.raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
canvas	var Canvas
fill	inferred	blankCell()

View source

fill

proc fill(canvas: var Canvas; area: Rect; cell = blankCell()) {.raises: [],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
canvas	var Canvas
area	Rect
cell	inferred	blankCell()

View source

copy

proc copy(canvas: Canvas): Canvas {.raises: [], tags: [], forbids: [].}

Returns: Canvas.

Arguments

Name	Type	Default
canvas	Canvas

View source

writeText

proc writeText(canvas: var Canvas; x, y: int; text: string;
               style = defaultStyle(); maxWidth = int.high) {.raises: [],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
canvas	var Canvas
x	int
y	int
text	string
style	inferred	defaultStyle()
maxWidth	inferred	int.high

View source

writeAnsiText

Write ANSI-styled text as semantic cells, preserving the base background.

proc writeAnsiText(canvas: var Canvas; x, y: int; text: string;
                   baseStyle = defaultStyle(); maxWidth = int.high) {.
    raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
canvas	var Canvas
x	int
y	int
text	string
baseStyle	inferred	defaultStyle()
maxWidth	inferred	int.high

View source

lineText

proc lineText(canvas: Canvas; y: int): string {.raises: [], tags: [],
    forbids: [].}

Returns: string.

Arguments

Name	Type	Default
canvas	Canvas
y	int

View source

plainText

proc plainText(canvas: Canvas): string {.raises: [], tags: [], forbids: [].}

Returns: string.

Arguments

Name	Type	Default
canvas	Canvas

View source