Modern Tui TuiBuffer InBounds

Home › Terminal TUI Library › Buffer and Frame › TuiBuffer.InBounds

TuiBuffer.InBounds

Returns true if x, y is inside the buffer.

Syntax

TuiBuffer.InBounds( byval x as int32, byval y as int32 ) as boolean

Description

Bounds check. At( ) does not check for you, so this is the guard when you index a buffer directly.

Example

#import "std/tui"
using tui

dim as TuiBuffer b
b.Resize( 10, 4 )
print b.InBounds( 9, 3 )          '' true
print b.InBounds( 10, 3 )         '' false
print b.InBounds( -1, 0 )         '' false

See also

TuiCell	TuiCell.Equals	TuiBuffer	TuiBuffer.Clear	TuiBuffer.Count	TuiFrame.Area
TuiCell.SetChar	TuiCellBlank	TuiBuffer.Resize	TuiBuffer.At	TuiFrame	TuiFrame.Clip

---

Library: Terminal TUI Library
Category: Terminal TUI Library
Documented under: Buffer and Frame
Working examples: hello.tiko · form.tiko · dashboard.tiko

---

Home · Keyword Index