painter

Documentation

Index

• type BorderStyle
• type LineSplitter
• type RenderRun
  • func (s *RenderRun) Advance() fixed.Int26_6
  • func (s *RenderRun) Bounds() image.Rectangle
  • func (s *RenderRun) Size() int
• type SquiggleStyle
• type StrikethroughStyle
• type TextPainter
  • func (tp *TextPainter) Paint(gtx layout.Context, shaper *text.Shaper, lines []lt.Line, ...)
  • func (tp *TextPainter) SetViewport(viewport image.Rectangle, scrollOff image.Point)
• type UnderlineStyle

Types

type BorderStyle

type BorderStyle struct {
	Color op.CallOp
}

type LineSplitter

type LineSplitter interface {
	// Split the line into runs and put the result in the runs array.
	Split(line lt.Line, runs *[]RenderRun)
}

LineSplitter defines the interface external styling source must implement to work with the painter. It used the Split api to split a line into a few RenderRuns.

type RenderRun

type RenderRun struct {
	Glyphs []text.Glyph
	// Offset is the pixel offset relative to the start of the line.
	Offset fixed.Int26_6

	// Fg is the text color encoded to Gio ops. This should be left empty
	// for runs originated from decorations.
	Fg op.CallOp
	// Bg is the background color encoded to Gio ops.
	Bg op.CallOp
	// Underline style for the run.
	Underline     *UnderlineStyle
	Squiggle      *SquiggleStyle
	Strikethrough *StrikethroughStyle
	Border        *BorderStyle
}

A RenderRun is a run of adjacent glyphs sharing the same style. This is used as the painting unit of the TextPainter.

func (*RenderRun) Advance

func (s *RenderRun) Advance() fixed.Int26_6

Advance returns the width of the run in pixels.

func (*RenderRun) Bounds

func (s *RenderRun) Bounds() image.Rectangle

Bounds returns the bounding box relative to the dot of the first glyph of the run.

func (*RenderRun) Size

func (s *RenderRun) Size() int

size returns the number of glyphs this run covers.

type SquiggleStyle

type SquiggleStyle struct {
	Color op.CallOp
}

type StrikethroughStyle

type StrikethroughStyle struct {
	Color op.CallOp
}

type TextPainter

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

TextPainter computes the bounding box of and paints text.

func (*TextPainter) Paint

func (tp *TextPainter) Paint(gtx layout.Context, shaper *text.Shaper, lines []lt.Line, defaultColor op.CallOp,
	syntaxTokens LineSplitter, decorations LineSplitter)

Paint paints text and various styles originated from syntax hignlighting or decorations.

func (*TextPainter) SetViewport

func (tp *TextPainter) SetViewport(viewport image.Rectangle, scrollOff image.Point)

type UnderlineStyle

type UnderlineStyle struct {
	Color op.CallOp
}