DrawScope

interface DrawScope

Inheritors

Properties

Link copied to clipboard
abstract val height: Int
Link copied to clipboard
abstract val width: Int

Functions

Link copied to clipboard
abstract fun drawCursor(row: Int, column: Int)

Places the terminal's cursor at row and column once this frame is rendered, and shows it. Use this for the caret of text input, since input methods show their composition at the cursor. When nothing places the cursor during a frame, it stays hidden below the output. The last placement in a frame wins.

Link copied to clipboard
abstract fun drawRect(char: Char, foreground: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified, topLeft: IntOffset = IntOffset.Zero, size: IntSize = this.size.offsetSize(topLeft), drawStyle: DrawStyle = DrawStyle.Fill)
abstract fun drawRect(codePoint: Int = UnspecifiedCodePoint, foreground: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified, topLeft: IntOffset = IntOffset.Zero, size: IntSize = this.size.offsetSize(topLeft), drawStyle: DrawStyle = DrawStyle.Fill)

Draws a rectangle with the given offset and size. If no offset from the top left is provided, it is drawn starting from the origin of the current translation. If no size is provided, the size of the current environment is used.

Link copied to clipboard
abstract fun drawText(row: Int, column: Int, string: String, foreground: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified, underlineStyle: UnderlineStyle = UnderlineStyle.Unspecified, underlineColor: Color = Color.Unspecified)
abstract fun drawText(row: Int, column: Int, string: AnnotatedString, foreground: Color = Color.Unspecified, background: Color = Color.Unspecified, textStyle: TextStyle = TextStyle.Unspecified, underlineStyle: UnderlineStyle = UnderlineStyle.Unspecified, underlineColor: Color = Color.Unspecified)