BLTerminalInterface

public protocol BLTerminalInterface : AnyObject

API for talking to BearLibTerminal. See BLTerminal for the concrete implementation. Use BLTerminal.main to get the main instance.

Each docstring briefly explains how it relates to the C API, so you’ll probably want to refer to the original documentation for more information.

By writing your code against this protocol instead of the concrete BLTerminal type, you enable unit testing and possible cross-platform compatibility adapters in the future.

open()
terminal_open()
Declaration
Swift

func open()
close()
terminal_close()
Declaration
Swift

func close()


                    
                    
                    configure(_:)

terminal_set()

Declaration

Swift

@discardableResult
func configure(_ config: String) -> Bool

refresh()
terminal_refresh()
Declaration
Swift

func refresh()
clear()
terminal_clear()
Declaration
Swift

func clear()
clear(area:)
terminal_clear_area()
Declaration
Swift

func clear(area: BLRect)
crop(area:)
terminal_crop()
Declaration
Swift

func crop(area: BLRect)
delay(milliseconds:)
terminal_delay()
Declaration
Swift

func delay(milliseconds: BLInt)
measure(string:)
terminal_measure()
Declaration
Swift

func measure(string: String) -> BLSize


                    
                    
                    measure(size:align:string:)

terminal_measure_ext()

Declaration

Swift

func measure(size: BLSize, align: BLInt, string: String) -> BLSize


                    
                    
                    print(point:string:)

terminal_print()

Declaration

Swift

@discardableResult
func print(point: BLPoint, string: String) -> BLSize


                    
                    
                    print(rect:align:string:)

terminal_print_ext()

Declaration

Swift

@discardableResult
func print(rect: BLRect, align: BLInt, string: String) -> BLSize

put(point:code:)
terminal_put()
Declaration
Swift

func put(point: BLPoint, code: BLInt)


                    
                    
                    put(point:code:offset:nw:sw:se:ne:)

terminal_put_ext()

Declaration

Swift

func put(point: BLPoint, code: BLInt, offset: BLPoint, nw: BLColor, sw: BLColor, se: BLColor, ne: BLColor)

getColor(name:)
color_from_name()
Declaration
Swift

func getColor(name: String) -> BLColor


                    
                    
                    getColor(a:r:g:b:)

color_from_argb()

Declaration

Swift

func getColor(a: UInt8, r: UInt8, g: UInt8, b: UInt8) -> BLColor


                    
                    
                    pickCode(point:index:)

terminal_pick()

Declaration

Swift

func pickCode(point: BLPoint, index: BLInt) -> BLInt


                    
                    
                    pickForegroundColor(point:index:)

terminal_pick_color()

Declaration

Swift

func pickForegroundColor(point: BLPoint, index: BLInt) -> BLColor

pickBackgroundColor(point:index:)
terminal_pick_bkcolor()
Declaration
Swift

func pickBackgroundColor(point: BLPoint, index: BLInt) -> BLColor
peek()
terminal_peek()
Declaration
Swift

func peek() -> Int32
read()
terminal_read()
Declaration
Swift

func read() -> Int32
state(_:)
terminal_state()
Declaration
Swift

func state(_ slot: Int32) -> Int32
check(_:)
terminal_check()
Declaration
Swift

func check(_ slot: Int32) -> Bool


                    
                    
                    readString(point:max:)

terminal_read_str()

Declaration

Swift

func readString(point: BLPoint, max: BLInt) -> String?

hasInput
terminal_has_input()
Declaration
Swift

var hasInput: Bool { get }
layer
terminal_layer() / terminal_state(TK_LAYER)
Declaration
Swift

var layer: BLInt { get set }
foregroundColor
terminal_color() / terminal_state(TK_COLOR)
Declaration
Swift

var foregroundColor: BLColor { get set }
backgroundColor
terminal_layer() / terminal_state(TK_LAYER)
Declaration
Swift

var backgroundColor: BLColor { get set }
isCompositionEnabled
terminal_composition() / terminal_state(TK_COMPOSITION)
Declaration
Swift

var isCompositionEnabled: Bool { get set }

waitForExit() Extension method
Block until the user quits. This isn’t part of the original BearLibTerminal library, but it’s convenient for quick experiments.
Declaration
Swift

public func waitForExit()