loom & weft
Made for Swift.

Unreleased APIs from PR #2. Not in 0.2.1. Stable 0.2.1 reference.

LOOM Unreleased (PR #2) / RENDERING, VIEWPORTS, AND COMPOSITION

FrameSnapshot

An owned logical frame captured after a successful draw, including styles and links.

Buffer uses value semantics: subsequent draws cannot change this snapshot. This records renderer state, not terminal scrollback or terminal-emulator behavior.

Standard inherited Swift protocol operations such as synthesized equality and OptionSet set operations are not repeated. The public declarations below are extracted from the exact source revision listed in the coverage manifest.

Members on this page

Feature guides and release status

FrameSnapshot

Structure
struct FrameSnapshot

Conforms to: Swift.Sendable, Swift.SendableMetatype.

An owned logical frame captured after a successful draw, including styles and links.

Buffer uses value semantics: subsequent draws cannot change this snapshot. This records renderer state, not terminal scrollback or terminal-emulator behavior.

Source · FrameSnapshot.swift:7

buffer

Instance Property
let buffer: Buffer

The mutable grid of cells for the frame.

Source · FrameSnapshot.swift:8

cursor

Instance Property
let cursor: Point?

The cursor position; see the type’s coordinate convention and lifecycle notes.

Source · FrameSnapshot.swift:9

init(buffer:cursor:)

Initializer
init(buffer: Buffer, cursor: Point?)

Creates a value with the supplied arguments. Default arguments are shown in the declaration.

Parameters (2)
buffer
Mutable destination cell grid.
cursor
Requested display cursor; nil hides it.
Source · FrameSnapshot.swift:11

differences(from:)

Instance Method
func differences(from other: FrameSnapshot) -> [String]

Human-readable geometry, cursor and cell differences from another snapshot.

Parameters (1)
from
Argument type and any default are shown in the declaration; see the behavior notes above.

Returns [String].

Source · FrameSnapshot.swift:17