KetraTerm
API · DevelopmentAll versions

TerminalRenderImages

Copied placement metadata in stacking order. Owned by a TerminalRenderCache; access has the same confinement/lease lifetime as that cache. Resources alone are immutable and retainable. Destination geometry uses fractional viewport cells; source crops use image pixels, as defined by TerminalRenderImageSink. Indexed reads require index in 0 until size and throw IllegalArgumentException otherwise. An update replaces this borrowed set, even when resources are reused.

Properties

Link copied to clipboard
var size: Int

Number of current placements, possibly sharing resources; zero for an empty or invalidated cache.

Functions

Link copied to clipboard
fun clipBottom(index: Int): Double

Reads the lower vertical clipping boundary.

Link copied to clipboard
fun clipTop(index: Int): Double

Reads the upper vertical clipping boundary.

Link copied to clipboard
fun column(index: Int): Double

Reads the destination's left edge.

Link copied to clipboard
fun copyTo(sink: TerminalRenderImageSink, rowOffset: Double = 0.0)

Delivers this set synchronously in stacking order, sharing immutable pixels. rowOffset translates destination rows and vertical clip bounds in cells; it does not change source crops, scaling or the stored placement set.

Link copied to clipboard
fun height(index: Int): Double

Reads the scaled destination height.

Link copied to clipboard

Retrieves the retainable pixel version, independently of client image IDs.

Link copied to clipboard
fun row(index: Int): Double

Reads the destination's top edge.

Link copied to clipboard
fun sourceHeight(index: Int): Int

Reads the source crop's height.

Link copied to clipboard
fun sourceWidth(index: Int): Int

Reads the source crop's width.

Link copied to clipboard
fun sourceX(index: Int): Int

Reads the source crop's left edge.

Link copied to clipboard
fun sourceY(index: Int): Int

Reads the source crop's top edge.

Link copied to clipboard
fun width(index: Int): Double

Reads the scaled destination width.

Link copied to clipboard
fun zIndex(index: Int): Int

Reads the placement's stacking layer.