Method

TermboxTerminalget_cell

Declaration

TbgCell*
tbg_terminal_get_cell (
  TbgTerminal* self,
  int x,
  int y,
  gboolean back,
  GError** error
)

Description

Return a snapshot copy of the cell at x, y.

The returned TbgCell is owned by the caller. It does not borrow memory from termbox.

Parameters

x

Type: int

X coordinate of the cell.

y

Type: int

Y coordinate of the cell.

back

Type: gboolean

TRUE to read the back buffer, or FALSE to read the front buffer.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will be left initialized to NULL by the method if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: TbgCell

A TbgCell, or NULL on error.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.

The return value can be NULL.