nimterm/geometry

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

Terminal-cell geometry and sizing constraints.

Types

Size = object
  w*: int
  h*: int

Rect = object
  x*: int
  y*: int
  w*: int
  h*: int

Constraints = object
  minSize*: Size
  maxSize*: Size

proc size(w, h: int): Size {.raises: [], tags: [], forbids: [].}

Returns: Size.

Name	Type	Default
`w`	`int`
`h`	`int`

proc rect(x, y, w, h: int): Rect {.raises: [], tags: [], forbids: [].}

Returns: Rect.

proc unconstrained(): Constraints {.raises: [], tags: [], forbids: [].}

Returns: Constraints.

proc clamp(constraints: Constraints; wanted: Size): Size {.raises: [], tags: [],
    forbids: [].}

Returns: Size.

Name	Type	Default
`constraints`	`Constraints`
`wanted`	`Size`

proc contains(area: Rect; x, y: int): bool {.raises: [], tags: [], forbids: [].}

Returns: bool.