[godoc] Update docs

Author: elgopher

image/image.go

@@ -24,6 +24,7 @@ type Image struct {
 	Pixels []byte
 }
 
+// String returns Image as string for debugging purposes.
 func (i Image) String() string {
 	return fmt.Sprintf("{width:%d, height:%d, palette: %+v, pixels:%s}",
 		i.Width, i.Height, sfmt.FormatBigSlice(i.Palette[:], 32), sfmt.FormatBigSlice(i.Pixels, 1000))

pi.go

@@ -3,6 +3,31 @@
 
 // Package pi provides API to develop retro games.
 //
+// Like other game development engines, Pi runs your game in a loop:
+//
+//	for {
+//	  pi.Update()
+//	  pi.Draw()
+//	  sleep() // sleep until next frame (30 frames per second)
+//	 }
+//
+// Both pi.Update and pi.Draw functions are provided by you. By default,
+// they do nothing. You can set them by using:
+//
+//	pi.Draw = func() {
+//	  pi.Print("HELLO WORLD", 40, 60, 7)
+//	}
+//
+// To run the game please use the ebitengine back-end by calling
+// ebitengine.Run or ebitengine.MustRun.
+//
+// During development, you might want to use dev-tools which provide tools
+// for screen inspection and REPL terminal, where you can write Go code
+// live when your game is running. To start the game with dev-tools
+// please use:
+//
+//	devtools.MustRun(ebitengine.Run)
+//
 // Please note that the entire pi package is not concurrency-safe.
 // This means that it is unsafe to run functions and access package
 // variables from go-routines started by your code.
@@ -15,7 +40,7 @@ import (
 	"github.com/elgopher/pi/font"
 )
 
-// User parameters.
+// User parameters
 var (
 	// Update is a user provided function executed each frame (30 times per second).
 	//
@@ -38,6 +63,7 @@ var (
 	Palette = defaultPalette
 )
 
+// Global state
 var (
 	// DrawPalette contains mapping of colors used to replace color with
 	// another one for all subsequent drawings.

pixmap.go

@@ -27,11 +27,6 @@ type PixMap struct {
 	wholeLinePix []byte
 }
 
-func (p PixMap) String() string {
-	return fmt.Sprintf("{width:%d, height:%d, clip:%+v, pix:%s}",
-		p.width, p.height, p.clip, sfmt.FormatBigSlice(p.pix, 1024))
-}
-
 // NewPixMap creates new instance of PixMap with specified size.
 // Width and height cannot be negative.
 func NewPixMap(width, height int) PixMap {
@@ -378,3 +373,9 @@ func addY(p Pointer, n int, lineWidth int) Pointer {
 	p.Pix = p.Pix[n*lineWidth:]
 	return p
 }
+
+// String returns PixMap as string for debugging purposes.
+func (p PixMap) String() string {
+	return fmt.Sprintf("{width:%d, height:%d, clip:%+v, pix:%s}",
+		p.width, p.height, p.clip, sfmt.FormatBigSlice(p.pix, 1024))
+}

print.go

@@ -62,11 +62,6 @@ type Font struct {
 	Height int
 }
 
-func (f Font) String() string {
-	return fmt.Sprintf("{width: %d, specialWidth: %d, height: %d, data: %s}",
-		f.Width, f.SpecialWidth, f.Height, sfmt.FormatBigSlice(f.Data, 512))
-}
-
 // Print prints text on the screen at given coordinates. It takes into account
 // clipping region and camera position.
 //
@@ -132,6 +127,12 @@ func (f Font) printRune(r rune, sx, sy int, color byte) int {
 	}
 }
 
+// String returns Font as string for debugging purposes.
+func (f Font) String() string {
+	return fmt.Sprintf("{width: %d, specialWidth: %d, height: %d, data: %s}",
+		f.Width, f.SpecialWidth, f.Height, sfmt.FormatBigSlice(f.Data, 512))
+}
+
 // Print prints text on the screen using system font. It takes into consideration
 // clipping region and camera position.
 //

screen.go

@@ -219,6 +219,7 @@ func PalReset() {
 	DisplayPalette = notSwappedPalette
 }
 
+// Scr returns the Screen PixMap
 func Scr() PixMap {
 	return screen
 }

sprite_sheet.go

@@ -60,6 +60,7 @@ type spriteSheet struct {
 	spritesInLine   int
 }
 
+// SprSheet returns the sprite-sheet PixMap
 func SprSheet() PixMap {
 	return sprSheet.PixMap
 }