segment

package

v0.10.0 Latest Latest Go to latest Published: Jun 5, 2019 License: Apache-2.0 Imports: 5 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/donaldww/termdash

Links

Open Source Insights

Documentation ¶

Overview ¶

Package segment provides functions that draw a single segment.

Index ¶

func Diagonal(bc *braille.Canvas, ar image.Rectangle, width int, dt DiagonalType, ...) error
func HV(bc *braille.Canvas, ar image.Rectangle, st Type, opts ...Option) error
type DiagonalOption
- func DiagonalCellOpts(cOpts ...cell.Option) DiagonalOption
type DiagonalType
- func (dt DiagonalType) String() string
type Option
type Type
- func (st Type) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Diagonal ¶

func Diagonal(bc *braille.Canvas, ar image.Rectangle, width int, dt DiagonalType, opts ...DiagonalOption) error

Diagonal draws a diagonal segment of the specified width filling the area.

func HV ¶

func HV(bc *braille.Canvas, ar image.Rectangle, st Type, opts ...Option) error

HV draws a horizontal or a vertical display segment, filling the provided area. The segment will have slopes on both of its ends.

Types ¶

type DiagonalOption ¶

type DiagonalOption interface {
	// contains filtered or unexported methods
}

DiagonalOption is used to provide options.

func DiagonalCellOpts ¶

func DiagonalCellOpts(cOpts ...cell.Option) DiagonalOption

DiagonalCellOpts sets options on the cells that contain the diagonal segment. Cell options on a braille canvas can only be set on the entire cell, not per pixel.

type DiagonalType ¶

type DiagonalType int

DiagonalType determines the type of diagonal segment.

const (

	// LeftToRight is a diagonal segment from top left to bottom right.
	LeftToRight DiagonalType
	// RightToLeft is a diagonal segment from top right to bottom left.
	RightToLeft
)

func (DiagonalType) String ¶

func (dt DiagonalType) String() string

String implements fmt.Stringer()

func CellOpts ¶

func CellOpts(cOpts ...cell.Option) Option

CellOpts sets options on the cells that contain the segment. Cell options on a braille canvas can only be set on the entire cell, not per pixel.

func ReverseSlopes ¶

func ReverseSlopes() Option

ReverseSlopes if provided reverses the order in which slopes are drawn. This only has a visible effect when the horizontal segment has height of two or the vertical segment has width of two. Without this option segments with height / width of two look like this:

| --- || |

With this option:

---  |
 -   ||
     |

func SkipSlopesLTE ¶

func SkipSlopesLTE(v int) Option

SkipSlopesLTE if provided instructs HV to not create slopes at the ends of a segment if the height of the horizontal or the width of the vertical segment is less or equal to the provided value.

type Type ¶

type Type int

Type identifies the type of the segment that is drawn.

const (

	// Horizontal is a horizontal segment.
	Horizontal Type
	// Vertical is a vertical segment.
	Vertical
)

func (Type) String ¶

func (st Type) String() string