EgdTextPanel.Renderer behaviour (egd_text_panel v0.1.0)

Copy Markdown View Source

Behaviour for rendering terminal output to an EGD image

Summary

Types

:egd.egd_image()

Renderer state

Callbacks

Called before the text is drawn

Render the final image

Types

egd_image()

@type egd_image() :: pid()

:egd.egd_image()

state()

@type state() :: term()

Renderer state

Initial state comes from the :renderer_state option that was passed to EgdTextPanel.start_link/1.

Callbacks

draw_background(egd_image, state)

@callback draw_background(egd_image(), state()) :: state()

Called before the text is drawn

render_image(egd_image, state)

@callback render_image(egd_image(), state()) :: state()

Render the final image