TUI Universal Buffers
| (require tui/ubuf) | package: tui-ubuf |
This package’s API is almost stable. Use with caution.
This package provides all the universal text buffer capabilities needed for both batch processing and interactive terminal application output.
It reprovides interface procedures from appropriate modules as needed.
Construction and related:
ubuf? - a type predicate
ubuf-width - renamed ubuf-clip-w
ubuf-height - renamed ubuf-clip-h
clip-ubuf - construct sub-buffer
move-ubuf - move origin of a buffer
unclip-ubuf - get the original buffer
ubuf-size - return the two values of width and height
Color management:
make-ubuf-truecolor - construct a valid RGB color value from its components
Drawing:
ubuf-putchar! - modify a single cell in the buffer
define-from-ubuf - define new bindings based on cell attributes
Overlay:
ubuf-copy! - copy entire buffer contents
ubuf-put! - put given buffer contents over an area within another one
Output parameters and programmatic display:
display-ubuf! - a programmatic way of displaying the buffer to terminal
Implicit display is achieved through the gen:custom-write generic interface. To display information about the buffer, use write or writeln. The same way any format-like procedures may be used with "~v" placeholder.
To output the contents of the buffer to current terminal, use simple display or displayln normally.