Compukters Core/compukter.display/GraphicalDisplay

GraphicalDisplay

value class GraphicalDisplay : Peripheral(source)

One persistent RGB canvas. Drawing is clipped to its bounds and publishes immediately by default.

Types

Companion

object Companion : TypedPeripheralProvider<GraphicalDisplay>

Properties

height

val height: Int

mode

val mode: DisplayMode

size

val size: Size2i

width

val width: Int

Functions

clear

fun clear(color: Int = 0)

fillRect

fun fillRect(bounds: Rect2i, color: Int)

fun fillRect(position: Position2i, size: Size2i, color: Int)

fun fillRect(x: Int, y: Int, width: Int, height: Int, color: Int)

frame

inline fun GraphicalDisplay.frame(block: DisplayFrame.() -> Unit)

Records bounded drawing packets and publishes them together. Exceptions discard the frame; nesting fails.

image

fun image(position: Position2i, size: Size2i, pixels: IntArray)

fun image(x: Int, y: Int, width: Int, height: Int, pixels: IntArray)

Draws tightly packed row-major RGB pixels. At most 65536 pixels per image.

line

fun line(start: Position2i, end: Position2i, color: Int)

fun line(x0: Int, y0: Int, x1: Int, y1: Int, color: Int)

pixel

fun pixel(position: Position2i, color: Int)

Typed pixel coordinates; floating vectors require an explicit rounding conversion.

fun pixel(x: Int, y: Int, color: Int)

pollClick

fun pollClick(): DisplayClick?

Takes the oldest click, or null. Claims this program's exclusive display lease.

pollPointer

fun pollPointer(): DisplayPointerEvent?

Polls transient held-right-click input in whole-screen coordinates, independently of pollClick.

rect

fun rect(bounds: Rect2i, color: Int)

fun rect(position: Position2i, size: Size2i, color: Int)

fun rect(x: Int, y: Int, width: Int, height: Int, color: Int)

setMode

fun setMode(mode: DisplayMode)

Changing density clears the image. Selecting the current mode preserves it.

setOpacity

fun setOpacity(opacity: Double)

Whole-panel opacity: 0.0 is invisible, 1.0 is opaque. Persists with the display; applies to text and background alike.

text

fun text(position: Position2i, text: String, color: Int = 16777215, scale: Int = 1)

fun text(x: Int, y: Int, text: String, color: Int = 16777215, scale: Int = 1)

Monospaced 6x12 glyphs, scaled by 1..8; newline starts the next line.