segdisp

Documentation

Overview

Package segdisp provides utilities used by all segment display types.

Index

• Constants
• func Required(cellArea image.Rectangle) (image.Rectangle, error)
• func SegmentSize(ar image.Rectangle) int
• func ToBraille(cvs *canvas.Canvas) (*braille.Canvas, image.Rectangle, error)

Constants

const (
	// MinCols is the smallest valid amount of columns in a cell area.
	MinCols = 6
	// MinRowPixels is the smallest valid amount of rows in a cell area.
	MinRows = 5
)

Minimum valid size of a cell canvas in order to draw a segment display.

Functions

func Required

func Required(cellArea image.Rectangle) (image.Rectangle, error)

Required when given an area of cells, returns either an area of the same size or a smaller area that is required to draw one segment display (i.e. one character). Returns a smaller area when the provided area didn't have the required aspect ratio. Returns an error if the area is too small to draw a segment display, i.e. smaller than MinCols x MinRows.

func SegmentSize

func SegmentSize(ar image.Rectangle) int

SegmentSize given an area for the display segment determines the size of individual segments, i.e. the width of a vertical or the height of a horizontal segment.

func ToBraille

func ToBraille(cvs *canvas.Canvas) (*braille.Canvas, image.Rectangle, error)

ToBraille converts the canvas into a braille canvas and returns a pixel area with aspect ratio adjusted for the segment display.