Raxol.Terminal.ScreenBuffer.EraseOperations (Raxol Terminal v2.6.0)

Handles all erase operations for the terminal screen buffer.

This module provides focused functionality for erasing content from the buffer, including line erasing, display erasing, and region clearing operations.

Summary

Functions

clear(buffer, style \\ nil)

Clears the entire buffer, creating a fresh empty grid.

clear_region(buffer, x, y, width, height)

Clears a specific region of the buffer.

delete_characters(buffer, row, col, count, default_style)

Deletes characters at a specific row/col position.

delete_chars(buffer, count, cursor, max_col)

Deletes characters at cursor position, shifting remaining cells left.

erase_all(buffer)

Erases the entire buffer.

erase_display(buffer, mode, cursor, min_row, max_row)

Erases display content based on mode (0=cursor-to-end, 1=start-to-cursor, 2=all).

erase_from_cursor_to_end(buffer)

Erases from the cursor to the end of the screen using the current cursor position.

erase_from_cursor_to_end(buffer, x, y, top, bottom)

Erases from cursor to end of display.

erase_from_start_to_cursor(buffer, x, y, top, bottom)

Erases from start to cursor position.

erase_in_display(buffer, arg, type)

Erases part or all of the display based on the cursor position and type. Type can be :to_end, :to_beginning, or :all.

erase_in_line(buffer, arg, type)

Erases part or all of the current line based on the cursor position and type. Type can be :to_end, :to_beginning, or :all.

erase_line(buffer, mode, cursor, min_col, max_col)

Erases line content based on mode (0=cursor-to-end, 1=start-to-cursor, 2=all).

erase_screen(buffer)

Erases the entire screen (alias for erase_all).

insert_chars(buffer, count, cursor, max_col)

Inserts blank characters at cursor position (no-op placeholder).

Functions

clear(buffer, style \\ nil)

Clears the entire buffer, creating a fresh empty grid.

clear_region(buffer, x, y, width, height)

@spec clear_region(
  Raxol.Terminal.ScreenBuffer.t(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer()
) :: Raxol.Terminal.ScreenBuffer.t()

Clears a specific region of the buffer.

delete_characters(buffer, row, col, count, default_style)

Deletes characters at a specific row/col position.

delete_chars(buffer, count, cursor, max_col)

Deletes characters at cursor position, shifting remaining cells left.

erase_all(buffer)

@spec erase_all(Raxol.Terminal.ScreenBuffer.t()) :: Raxol.Terminal.ScreenBuffer.t()

Erases the entire buffer.

erase_display(buffer, mode, cursor, min_row, max_row)

Erases display content based on mode (0=cursor-to-end, 1=start-to-cursor, 2=all).

erase_from_cursor_to_end(buffer)

@spec erase_from_cursor_to_end(Raxol.Terminal.ScreenBuffer.t()) ::
  Raxol.Terminal.ScreenBuffer.t()

Erases from the cursor to the end of the screen using the current cursor position.

erase_from_cursor_to_end(buffer, x, y, top, bottom)

@spec erase_from_cursor_to_end(
  map(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer()
) :: map()

Erases from cursor to end of display.

erase_from_start_to_cursor(buffer, x, y, top, bottom)

@spec erase_from_start_to_cursor(
  map(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer()
) :: map()

Erases from start to cursor position.

erase_in_display(buffer, arg, type)

@spec erase_in_display(
  Raxol.Terminal.ScreenBuffer.t(),
  {non_neg_integer(), non_neg_integer()},
  atom()
) :: Raxol.Terminal.ScreenBuffer.t()

Erases part or all of the display based on the cursor position and type. Type can be :to_end, :to_beginning, or :all.

erase_in_line(buffer, arg, type)

@spec erase_in_line(
  Raxol.Terminal.ScreenBuffer.t(),
  {non_neg_integer(), non_neg_integer()},
  atom()
) :: Raxol.Terminal.ScreenBuffer.t()

Erases part or all of the current line based on the cursor position and type. Type can be :to_end, :to_beginning, or :all.

erase_line(buffer, mode, cursor, min_col, max_col)

Erases line content based on mode (0=cursor-to-end, 1=start-to-cursor, 2=all).

erase_screen(buffer)

Erases the entire screen (alias for erase_all).

insert_chars(buffer, count, cursor, max_col)

Inserts blank characters at cursor position (no-op placeholder).