record

Documentation

Overview

Package record captures gameplay frames and writes an animated GIF. It exists so any Collider game can produce a shareable clip with zero tooling: set COLLIDER_RECORD=demo.gif, play, close the window.

Index

• type Recorder
  • func New(path string, w, h int) *Recorder
  • func (r *Recorder) Add(pix []byte)
  • func (r *Recorder) Save()
  • func (r *Recorder) ShouldCapture() bool

Types

type Recorder

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

Recorder accumulates downscaled palettized frames and encodes them on Save. All methods run on the game loop; nothing is concurrent.

func New

func New(path string, w, h int) *Recorder

func (*Recorder) Add

func (r *Recorder) Add(pix []byte)

Add consumes one full-resolution RGBA frame (4 bytes per pixel).

func (*Recorder) Save

func (r *Recorder) Save()

Save encodes the captured frames as an animated GIF.

func (*Recorder) ShouldCapture

func (r *Recorder) ShouldCapture() bool

ShouldCapture throttles capture to the GIF frame rate regardless of the display's refresh rate.