max_72xx v0.1.0 Max72XX.Array.Buffer View Source

Represents an array buffer.

This module is used to store/manipulate the bitmap data in an array.

As the array module allows to load buffers it can be useful to implement a backbuffer.

Link to this section Summary

Types

t()

Functions

Clear buffer (All pixels off)

get_dimensions(buffer)

Returns the buffer dimensions

load_bitmap(buffer, data)

Load bitmap data The bitmap needs to fit the array bitmap dimensions (array_size * 16 bytes)

load_buffer(buffer, src)

Load the bitmap data from other buffer. Both buffers needs to have same dimensions.

new(array_size)

Create new buffer

set_pixel(buffer, x, y, state \\ true)

Set a pixel on or off

to_commands(buffer)

Returns the list of commands to be send to load the buffer in the device. This method is used internally by Array to transfer the data.

Link to this section Types

pixel_state()

pixel_state() :: boolean()

t()

t() :: %Max72XX.Array.Buffer{array_size: term(), data: term()}

Link to this section Functions

clear(buffer)

clear(buffer :: t()) :: t()

Clear buffer (All pixels off)

get_dimensions(buffer)

get_dimensions(buffer :: t()) :: {width :: integer(), height :: integer()}

Returns the buffer dimensions

load_bitmap(buffer, data)

load_bitmap(buffer :: t(), bitmap :: binary()) ::
  {:ok, t()} | {:error, :size}

Load bitmap data The bitmap needs to fit the array bitmap dimensions (array_size * 16 bytes)

load_buffer(buffer, src)

load_buffer(buffer :: t(), source :: t()) ::
  {:ok, t()} | {:error, :size}

Load the bitmap data from other buffer. Both buffers needs to have same dimensions.

new(array_size)

new(integer()) :: Max72XX.Array.Buffer.t()

Create new buffer

set_pixel(buffer, x, y, state \\ true)

set_pixel(
  buffer :: t(),
  x :: integer(),
  y :: integer(),
  state :: pixel_state()
) :: t()

Set a pixel on or off

to_commands(buffer)

Returns the list of commands to be send to load the buffer in the device. This method is used internally by Array to transfer the data.