Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

canvas

package

Go to main page

Versions in this module

v0

v0.13.0

Aug 11, 2026

Changes in this version

type Canvas

+ func (c *Canvas) SaveCanvasToText(filename string)

v0.12.0

Jul 22, 2026

v0.11.1

Jun 12, 2026

v0.11.0

Jun 11, 2026

Changes in this version

+ func Run(ctx context.Context, setup, draw func(c *Canvas), opts ...CallbackOption)

+ func Start(ctx context.Context, done chan struct{}, setup, draw func(c *Canvas), ...) *sync.WaitGroup

+ type CallbackOption func(*callbacks)

+ func WithOnKey(onKey func(c *Canvas, e KeyEvent)) CallbackOption

+ func WithOnMouseClick(onMouseClick func(c *Canvas, e MouseEvent)) CallbackOption

+ func WithOnMouseMove(onMouseMove func(c *Canvas, e MouseEvent)) CallbackOption

+ func WithOnMouseRelease(onMouseRelease func(c *Canvas, e MouseEvent)) CallbackOption

+ func WithOnMouseWheel(onMouseWheel func(c *Canvas, e MouseEvent)) CallbackOption

+ type Canvas struct

+ Framecount int

+ Height int

+ IsLooping bool

+ MouseX int

+ MouseY int

+ Width int

+ func (c *Canvas) Background(text, fg, bg string)

+ func (c *Canvas) BackgroundBg(bg string)

+ func (c *Canvas) BackgroundFg(fg string)

+ func (c *Canvas) BackgroundText(text string)

+ func (c *Canvas) Bezier(x1, y1, x2, y2, x3, y3, x4, y4 int)

+ func (c *Canvas) CellModeCustom(char string)

+ func (c *Canvas) CellModeDefault()

+ func (c *Canvas) CellModeDouble()

+ func (c *Canvas) CellPadding(char string)

+ func (c *Canvas) CellPaddingDouble(char string)

+ func (c *Canvas) Circle(xCenter, yCenter, r int)

+ func (c *Canvas) Clear()

+ func (c *Canvas) ColorHSL(h, s, l int) string

+ func (c *Canvas) ColorHSV(h, s, v int) string

+ func (c *Canvas) ColorRGB(r, g, b int) string

+ func (c *Canvas) Debug(messages ...any)

+ func (c *Canvas) DisableRendering()

+ func (c *Canvas) Dist(x1, y1, x2, y2 int) float64

+ func (c *Canvas) Ellipse(xCenter, yCenter, rx, ry int)

+ func (c *Canvas) Exit()

+ func (c *Canvas) Fill(text, fg, bg string)

+ func (c *Canvas) FillBg(bg string)

+ func (c *Canvas) FillFg(fg string)

+ func (c *Canvas) FillText(text string)

+ func (c *Canvas) Fps(fps int)

+ func (c *Canvas) Get(x, y, w, h int) Image

+ func (c *Canvas) Image(img Image, x, y, w, h int)

+ func (c *Canvas) Line(x1, y1, x2, y2 int)

+ func (c *Canvas) LoadImage(path string) Image

+ func (c *Canvas) Loop()

+ func (c *Canvas) LoopAngle(duration int) float64

+ func (c *Canvas) Map(value, inputStart, inputEnd, outputStart, outputEnd float64) float64

+ func (c *Canvas) NoCellPadding()

+ func (c *Canvas) NoFill()

+ func (c *Canvas) NoLoop()

+ func (c *Canvas) NoStroke()

+ func (c *Canvas) Noise1D(x float64) float64

+ func (c *Canvas) Noise2D(x, y float64) float64

+ func (c *Canvas) NoiseLoop(angle, radius float64) float64

+ func (c *Canvas) NoiseLoop1D(angle, radius float64, x int) float64

+ func (c *Canvas) NoiseLoop2D(angle, radius float64, x, y int) float64

+ func (c *Canvas) NoiseSeed(seed int64)

+ func (c *Canvas) Point(x, y int)

+ func (c *Canvas) Pop()

+ func (c *Canvas) Push()

+ func (c *Canvas) Quad(x1, y1, x2, y2, x3, y3, x4, y4 int)

+ func (c *Canvas) Random(minimum, maximum int) float64

+ func (c *Canvas) RandomSeed(seed int64)

+ func (c *Canvas) Rect(x, y, w, h int)

+ func (c *Canvas) Redraw()

+ func (c *Canvas) Rotate(angle float64)

+ func (c *Canvas) SaveCanvasToGIF(filename string, duration int)

+ func (c *Canvas) SaveCanvasToMP4(filename string, duration int)

+ func (c *Canvas) SaveCanvasToPNG(filename string)

+ func (c *Canvas) SavedCanvasFont(filename string)

+ func (c *Canvas) SavedCanvasFontSize(size int)

+ func (c *Canvas) Scale(scale float64)

+ func (c *Canvas) Set(x, y int, cells writable)

+ func (c *Canvas) Size(w, h int)

+ func (c *Canvas) Square(x, y, size int)

+ func (c *Canvas) Stroke(text, fg, bg string)

+ func (c *Canvas) StrokeBg(bg string)

+ func (c *Canvas) StrokeFg(fg string)

+ func (c *Canvas) StrokeText(text string)

+ func (c *Canvas) Text(text string, x, y int)

+ func (c *Canvas) Translate(x, y int)

+ func (c *Canvas) Triangle(x1, y1, x2, y2, x3, y3 int)

+ type Cell struct

+ Background string

+ Char string

+ Foreground string

+ type Image interface

+ Cell func(x, y int) Cell

+ type KeyEvent struct

+ Code int

+ Key string

+ type MouseEvent struct

+ Button string

+ X int

+ Y int

+ type Number interface