textile

Documentation

Overview

Package textile weaves strings into a text image.

Index

• func Draw(dst *Textile, r image.Rectangle, src *Textile, sp image.Point)
• type Textile
  • func New(r image.Rectangle) *Textile
  • func (t *Textile) At(x, y int) string
  • func (t *Textile) Bounds() image.Rectangle
  • func (t *Textile) Fill(str string)
  • func (t Textile) Lines() []string
  • func (t Textile) LinesWithFill(fillZero string) []string
  • func (t *Textile) Set(x, y int, str string)
  • func (t *Textile) StringsOffset(x, y int) int
  • func (t *Textile) SubText(r image.Rectangle) *Textile

Functions

func Draw

func Draw(dst *Textile, r image.Rectangle, src *Textile, sp image.Point)

Draw writes the text from a source textile onto a destination textile, within a rectangle of the destination textile, offset by a position within the source textile.

Types

type Textile

type Textile struct {
	Strings []string
	Stride  int
	Rect    image.Rectangle
}

Textile represents every cell in a display as a string that ideally renders as a single glyph. Like images and slices, the textile is a thin header that can share allocated memory with other textiles.

func New

func New(r image.Rectangle) *Textile

New returns a Textile with the given rectangle. As with images, the rectangle need not rest at the origin.

func (*Textile) At

func (t *Textile) At(x, y int) string

At returns the string at a given point.

func (*Textile) Bounds

func (t *Textile) Bounds() image.Rectangle

Bounds returns the bounding box of the textile.

func (*Textile) Fill

func (t *Textile) Fill(str string)

Fill overwrites every cell in the textile with the given string.

func (Textile) Lines

func (t Textile) Lines() []string

Lines returns a slice of row strings from the textile.

func (Textile) LinesWithFill

func (t Textile) LinesWithFill(fillZero string) []string

LinesWithFill returns a slice of row strings from the textile, filling in any empty strings with the given one.

func (*Textile) Set

func (t *Textile) Set(x, y int, str string)

Set overwrites the string at a point.

func (*Textile) StringsOffset

func (t *Textile) StringsOffset(x, y int) int

StringsOffset is a utility for seeking a slice of the underlying strings starting at the given position within the allocation.

func (*Textile) SubText

func (t *Textile) SubText(r image.Rectangle) *Textile

SubText returns a region of text within the textile.