Modern Tui TuiRect

Home › Terminal TUI Library › Geometry › TuiRect

TuiRect

Holds a rectangle of cells: x, y, width and height, counted from 0.

Syntax

type TuiRect
    as int32 x, y, w, h
end type

Description

The only rectangle in the module. Everything is 0-based: VT coordinates are 1-based and the conversion happens inside the renderer, where you never see it.

Example

#import "std/tui"
using tui

dim as TuiRect r = TuiRectOf( 4, 2, 20, 6 )
print r.x, r.y, r.w, r.h          '' 4 2 20 6
print r.Right( ), r.Bottom( )     '' 24 8  -- x+w and y+h, one PAST the edge

'' A rect is a value. Passing one copies it; there is nothing to free.
dim as TuiRect copy_ = r
copy_.w = 1
print r.w                         '' 20 -- unchanged

See also

TuiRect.Right	TuiRect.IsEmpty	TuiRect.Intersect	TuiRect.Equals	TuiSize	TuiPos
TuiRect.Bottom	TuiRect.Contains	TuiRect.Inner	TuiRectOf	TuiSizeOf	TuiMargin

---

Library: Terminal TUI Library
Category: Terminal TUI Library
Documented under: Geometry
Working examples: hello.tiko · form.tiko · dashboard.tiko

---

Home · Keyword Index