segdisp

package

v0.20.0 Latest Latest Go to latest Published: Mar 10, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mum4k/termdash

Links

Open Source Insights

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 ¶

View Source

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.

Variables ¶

This section is empty.

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.

Types ¶

This section is empty.

Source Files ¶

View all Source files

segdisp.go

Directories ¶

Path	Synopsis
dotseg Package dotseg simulates a segment display that can draw dots.	Package dotseg simulates a segment display that can draw dots.
testdotseg Package testdotseg provides helpers for tests that use the dotseg package.	Package testdotseg provides helpers for tests that use the dotseg package.
segment Package segment provides functions that draw a single segment.	Package segment provides functions that draw a single segment.
testsegment Package testsegment provides helpers for tests that use the segment package.	Package testsegment provides helpers for tests that use the segment package.
sixteen Package sixteen simulates a 16-segment display drawn on a canvas.	Package sixteen simulates a 16-segment display drawn on a canvas.
testsixteen Package testsixteen provides helpers for tests that use the sixteen package.	Package testsixteen provides helpers for tests that use the sixteen package.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL