gui

Documentation

Index

• func Available() bool
• func BarHeight(squareSize int) int
• func DrawFrame(c *canvas.Canvas, cfg Config, f Faces, v BoardView)
• func FrameSize(cfg Config) (w, h int)
• func Render(cfg Config) error
• func Run(cfg Config) error
• type BoardView
• type Config
  • func DefaultConfig() Config
• type Faces
  • func LoadFaces(squareSize, barHeight int) (Faces, error)

Functions

func Available

func Available() bool

func BarHeight

func BarHeight(squareSize int) int

BarHeight is the info bar's height for a given square size, floored so the two lines of text always fit.

func DrawFrame

func DrawFrame(c *canvas.Canvas, cfg Config, f Faces, v BoardView)

DrawFrame composes a whole frame onto c: the board, the highlights, the pieces, the info bar and — once the game ends — the result banner. Drawing through the software canvas rather than the display means the same code paints a live window and a headless recording, pixel for pixel.

func FrameSize

func FrameSize(cfg Config) (w, h int)

FrameSize is the window's pixel size for a given square size.

func Render

func Render(cfg Config) error

Render records a game to cfg.Rec.Path without opening a window, one frame per move. Frames come from the same DrawFrame the window uses, so the media matches what a player sees — and it needs no display.

The file extension picks the format: .gif or .mp4.

func Run

func Run(cfg Config) error

Types

type BoardView

type BoardView struct {
	Snapshot [64]chess.Piece
	Flipped  bool
	Selected chess.Square
	// Legal is the current legal move list, used to light up the squares the
	// selected piece can reach.
	Legal []chess.Move

	WhiteName, BlackName string
	Moves                int
	Over                 bool
	Paused               bool
	AwaitingHuman        bool
	Result               chess.Result
	DrawReason           chess.DrawReason
}

BoardView is everything a frame draws: the position, what the player has selected, and how the game stands.

type Config

type Config struct {
	Game    *game.Game
	NewGame func() *game.Game
	Logger  *applog.Logger

	SquareSize   int
	LightSquare  color.RGBA
	DarkSquare   color.RGBA
	MoveDelay    time.Duration
	ThinkTimeout time.Duration

	// Rec names the recording [Render] writes; RecordDelay is gambit's own
	// per-move frame delay for the paced clip. Both are set by tools/demogen.
	Rec         record.Options
	RecordDelay int
}

func DefaultConfig

func DefaultConfig() Config

type Faces

type Faces struct {
	Piece  font.Face
	Bar    font.Face
	Banner font.Face
}

Faces are the three sizes the board draws in: the piece figurines, the info bar, and the end-of-game banner.

func LoadFaces

func LoadFaces(squareSize, barHeight int) (Faces, error)

LoadFaces renders the bundled font at the sizes a board of the given square size needs. It returns display-free faces, so the same typography serves a live window and a headless recording.