- CELL OBJECTS
Term::VTerm::Screen - provides access to the screen layer of libvterm
$screen->enable_altscreen( $enabled )
Controls whether the altscreen buffer is enabled. Doing so allows the DEC altscreen mode to switch between regular and alternate screen buffers, but consumes more memory.
Flushes all pending damage through the screen to the damage callback.
$screen->set_damage_merge( $size )
Sets the damage merge size, as one of the
$screen->reset( $hard )
Resets the terminal state; performing either a soft or hard reset depending on the (optional) boolean value given.
$cell = $screen->get_cell( $pos )
VTermScreenCell object representing the current state of the cell at the given location. Note that this is an instantaneous snapshot - the returned object will not update to reflect later changes in the screen's state.
$str = $screen->get_text( $rect )
Returns a UTF-8 string containing the text in the screen buffer within the given
$screen->set_callbacks( %cbs )
Sets the screen-layer callbacks. Takes the following named arguments:
- on_damage => CODE
$on_damage->( $rect )
- on_moverect => CODE
$on_moverect->( $dest, $src )
- on_movecursor => CODE
$on_movecursor->( $pos, $oldpos, $is_visible )
$is_visibleis a boolean.
- on_settermprop => CODE
$on_settermprop->( $prop, $value )
$propis one of the
PROP_*constants. The type of
$valuedepends on the property type - see similar to
- on_bell => CODE
- on_resize => CODE
$on_resize->( $rows, $cols )
$col = $screen->convert_color_to_rgb( $col )
VTermColor structure from indexed to RGB form.
VTermScreenCell instance has the following field accessors:
A list of Unicode character numbers. This list does not include the terminating 0.
A UTF-8 string containing the characters (normally just one but it may be followed by zero-width combining marks).
The width of the cell in columns. Normally 1, but 2 for a Unicode double-width character, or the special value of -1 on the "second" cell of such a character.
Simple rendering attributes. All are boolean values, except
underline which is an integer between 0 and 2 (to support double-underline).
Font selection; an integer between 0 and 10.
The foreground and background colours, as
Paul Evans <firstname.lastname@example.org>