screen1d

Documentation

Overview

Package screen1d implements a 1D display.Drawer that outputs to terminal (stdout) using ANSI color codes.

Useful while you are waiting for your super nice APA-102 LED strip to come by mail.

Index

• type Dev
  • func New(opts *Opts) *Dev
  • func (d *Dev) Bounds() image.Rectangle
  • func (d *Dev) ColorModel() color.Model
  • func (d *Dev) Draw(r image.Rectangle, src image.Image, sp image.Point) error
  • func (d *Dev) Halt() error
  • func (d *Dev) String() string
  • func (d *Dev) Write(pixels []byte) (int, error)
• type Opts

Types

type Dev

type Dev struct {
	// contains filtered or unexported fields
}

Dev is a 1D LED strip emulator that outputs to the console.

func New

func New(opts *Opts) *Dev

New returns a Dev that displays at the console.

Permits to do local testing of LEDs animation.

func (*Dev) Bounds

func (d *Dev) Bounds() image.Rectangle

Bounds implements display.Drawer.

func (*Dev) ColorModel

func (d *Dev) ColorModel() color.Model

ColorModel implements display.Drawer.

func (*Dev) Draw

func (d *Dev) Draw(r image.Rectangle, src image.Image, sp image.Point) error

Draw implements display.Drawer.

func (*Dev) Halt

func (d *Dev) Halt() error

Halt implements conn.Resource.

It clears the display so it is not corrupted.

func (*Dev) String

func (d *Dev) String() string

func (*Dev) Write

func (d *Dev) Write(pixels []byte) (int, error)

Write accepts a stream of raw RGB pixels and writes it to the console.

type Opts

type Opts struct {
	X       int
	Palette *ansi256.Palette
}

Opts represents the options available for this display.