Raxol.Terminal.ScreenBuffer.Operations.Erasing (Raxol v2.0.1)

View Source

Erasing operations for the screen buffer.

This module handles various erasing operations including erase in display and erase in line with different modes.

Summary

Functions

erase_in_display(buffer, mode, cursor_pos \\ %{x: 0, y: 0})

Erases in display based on mode.

erase_in_line(buffer, mode, cursor_pos \\ %{x: 0, y: 0})

Erases in line based on mode.

Functions

erase_in_display(buffer, mode, cursor_pos \\ %{x: 0, y: 0})

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

Erases in display based on mode.

Mode values:

  • 0: From cursor to end of display
  • 1: From start to cursor
  • 2: Entire display
  • 3: Entire display including scrollback

erase_in_line(buffer, mode, cursor_pos \\ %{x: 0, y: 0})

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

Erases in line based on mode.

Mode values:

  • 0: From cursor to end of line
  • 1: From start of line to cursor
  • 2: Entire line