Module wonderful.buffer.storage52

Buffer storage classes for Lua 5.2.

Classes and inheritance

BufferStorage The base buffer storage class.
BufferStorageT1 The T1 buffer storage class.
BufferStorageT2 The T2 buffer storage class.
BufferStorageT3 The T3 buffer storage class.

Class BufferStorage

BufferStorage.data The data struct.
BufferStorage:__new__(w, h) The abstract base buffer constructor.
BufferStorage:clear() The abstract clear method that must clear the buffer storage.
BufferStorage:indexMain(x, y) The abstract main cell index getter.
BufferStorage:indexDiff(x, y) The abstract diff cell index getter.
BufferStorage:getMain(x, y) Get a given main cell's character and packed color.
BufferStorage:getDiff(x, y) Get a given diff cell's character and packed color.


Classes and inheritance

BufferStorage
The base buffer storage class.
BufferStorageT1
The T1 buffer storage class.

Parent classes:

BufferStorageT2
The T2 buffer storage class.

Parent classes:

BufferStorageT3
The T3 buffer storage class.

Parent classes:

Class BufferStorage

BufferStorage.data
The data struct. Given i, j, the cell's character and packed color should be available as storage.data[i][j] and storage.data[i][j + 1], respectively.
BufferStorage:__new__(w, h)
The abstract base buffer constructor.

Parameters:

  • w int a width
  • h int a height
BufferStorage:clear()
The abstract clear method that must clear the buffer storage.
BufferStorage:indexMain(x, y)
The abstract main cell index getter.

Parameters:

  • x int a cell column number
  • y int a cell row number

Returns:

  1. int i
  2. int j
BufferStorage:indexDiff(x, y)
The abstract diff cell index getter.

Parameters:

  • x int a cell column number
  • y int a cell row number

Returns:

  1. int i
  2. int j
BufferStorage:getMain(x, y)
Get a given main cell's character and packed color.

Parameters:

  • x int a cell column number
  • y int a cell row number

Returns:

  1. optional string a character
  2. optional int a packed color
BufferStorage:getDiff(x, y)
Get a given diff cell's character and packed color.

Parameters:

  • x int a cell column number
  • y int a cell row number

Returns:

  1. optional string a character
  2. optional int a packed color
generated by LDoc 1.4.6 Last updated 2019-07-27 21:32:05