Screen returns the current Screen of a Game.

SetPosition sets the coordinates of the Text to be (x, y).

Start starts a Game running. This should be the last thing called in your main function. By default, the escape key exits.

Set the screen framerate. By default, termloop will draw the the screen as fast as possible, which may use a lot of system resources.

AddEntity adds Drawable d to the level's entities.

Return position, x and y

NewCanvas returns a new Canvas, with width and height defined by arguments.

SetCell updates the attribute of the Cell at x, y to match those of c. The coordinates are relative to the entity itself, not the Screen.

SetLevel sets the Screen's current level to be l.

ApplyCanvas takes a pointer to a Canvas, c, and applies this canvas over the top of the Entity's canvas. Any new values in c will overwrite those in t

Color returns the (foreground, background) colors of the Text.

RenderCell updates the Cell at a given position on the Screen with the attributes in Cell c.

SetColor sets the (foreground, background) colors of the Text to fg, bg respectively.

Log takes a log string and additional parameters, which can be substituted into the string using standard fmt.Printf rules. The formatted string is ad

NewText creates a new Text, at position (x, y). It sets the Text's background and foreground colors to fg and bg respectively, and sets the Text's tex

SetOffset sets the level's drawing offset to be (x, y). The drawing offset can be used to simulate moving the level, or moving the 'camera'.

SetText sets the text of the Text to be text.

Stop shuts down PortAudio

TimeDelta returns the number of seconds since the previous frame was rendered. Can be used for timings and animation.

Image processing

BackgroundCanvasFromFile takes a path to an image file, and creates a canvas of background-only Cells representing the image. This can be applied to a

CanvasFromString returns a new Canvas, built from the characters in the string str. Newline characters in the string are interpreted as a new Canvas r

Return width and height

EnablePixelMode sets the screen to 'pixel mode' - giving double the canvas height while sacrificing character drawing ability.

ForegroundCanvasFromFile takes a path to an image file, and creates a canvas of foreground-only Cells representing the image. This can be applied to a

Level returns the Screen's current level.

LoadTrack reads an audio track from a file, and returns a pointer to a Track struct, or an error. The boolean parameter 'loop' determines whether or n

NewEntityFromCanvas returns a pointer to a new Entity, with position (x, y) and Canvas c. Width and height are calculated using the Canvas.

NewRectangle creates a new Rectangle at position (x, y), with size (width, height) and color color. Returns a pointer to the new Rectangle.

NewScreen creates a new Screen, with no entities or level. Returns a pointer to the new Screen.

Pause stops a Track playing, but does not reset its position. The track can be resumed by calling Play().

Play triggers a Track to start playing.

Restart resets the Track to the beginning but does not stop playback.

RgbTo256Color takes RGB values and returns the closest color for a 256-color terminal, as an Attr type.

SetDebugOn sets debug mode's on status to be debugOn.

Size returns the width and height of the Text.

Generates a maze using Prim's Algorithm https://en.wikipedia.org/wiki/Maze_generation_algorithm#Randomized_Prim.27s_algorithm

AddEntity adds a Drawable to the current Screen, to be rendered.

Color returns the color of the Rectangle.

DebugOn returns a bool showing whether or not debug mode is on.

Draw is called every frame by the Game to render the current state of the screen.

Draw draws the Text to the Screen s.

Draws the Rectangle r onto Screen s.

Draw draws the level's entities to the Screen s.

Method for processing events, e.g. input

Draw updates the framerate on the FpsText and draws it to the Screen s.

Draw draws the entity to its current position on the screen. This is usually called every frame.

DrawBackground draws the background Cell bg to each Cell of the Screen s.

Fill fills the canvas of the Entity with a Cell c.

InitAudio starts up PortAudio, creates a stream and returns a pointer to an Audio struct, or an error.

LoadLevelFromMap can be used to populate a Level with entities, given a JSON string to read from (jsonMap). The map 'parsers' is a map of entity name

Looping returns whether or not the Track is set to loop.

NewBaseLevel creates a new BaseLevel with background bg. Returns a pointer to the new BaseLevel.

NewEntity creates a new Entity, with position (x, y) and size (width, height). Returns a pointer to the new Entity.

NewFpsText creates a new FpsText at position (x, y) and with background and foreground colors fg and bg respectively. It will refresh every 'update' s