More documentation!

This commit is contained in:
Sasha Koshka 2023-02-09 15:05:13 -05:00
parent 2cd670f4cd
commit b38232ee24
6 changed files with 19 additions and 2 deletions

5
artist/doc.go Normal file
View File

@ -0,0 +1,5 @@
// Package artist provides a simple 2D drawing library for canvas.Canvas.
// Artist's drawing functions take in things called patterns, which are sampled
// as a source in order to color and texture drawn shapes. Patterns can be
// mixed together and composited to create new, more complex patterns.
package artist

4
canvas/doc.go Normal file
View File

@ -0,0 +1,4 @@
// Package canvas provides a canvas interface that is able to return a pixel
// buffer for drawing. This makes it considerably more efficient than the
// standard draw.Image.
package canvas

View File

@ -2,6 +2,6 @@
// interfaces without having to duplicate a ton of code. Each "core" is a type // interfaces without having to duplicate a ton of code. Each "core" is a type
// that can be embedded into an element directly, working to fulfill a // that can be embedded into an element directly, working to fulfill a
// particular interface. Each one comes with a corresponding core control, which // particular interface. Each one comes with a corresponding core control, which
// provides an interface for elements to exert control over the core. They // provides an interface for elements to exert control over the core. Core
// should be kept private. // controls should be kept private.
package core package core

View File

@ -0,0 +1,4 @@
// Package music provides types relating to music theory and the math behind it.
// It is used in the fun.Piano element, and in the piano example to generate
// pitches from notes.
package music

View File

@ -43,6 +43,7 @@ const (
NoteBb0 NoteBb0
NoteB0 NoteB0
// nice
NoteA4 Note = 69 NoteA4 Note = 69
) )

3
textmanip/doc.go Normal file
View File

@ -0,0 +1,3 @@
// Package textmanip provides text manipulation functions that are useful for
// creating editable text fields.
package textmanip