encode

Documentation

Index

• Constants
• type ImageFilter
• type Screens
  • func ScreensFromImages(images ...image.Image) *Screens
  • func ScreensFromRoots(roots []render.Root) *Screens
  • func (s *Screens) EncodeGIF(maxDuration int, filters ...ImageFilter) ([]byte, error)
  • func (s *Screens) EncodeWebP(maxDuration int, filters ...ImageFilter) ([]byte, error)
  • func (s *Screens) Hash() ([]byte, error)

Constants

const (
	WebPKMin                 = 0
	WebPKMax                 = 0
	DefaultScreenDelayMillis = 50
	DefaultMaxAgeSeconds     = 0 // 0 => no max age, cache forever!
)

Types

type ImageFilter

type ImageFilter func(image.Image) (image.Image, error)

type Screens

type Screens struct {
	MaxAge            int32
	ShowFullAnimation bool
	// contains filtered or unexported fields
}

func ScreensFromImages

func ScreensFromImages(images ...image.Image) *Screens

func ScreensFromRoots

func ScreensFromRoots(roots []render.Root) *Screens

func (*Screens) EncodeGIF

func (s *Screens) EncodeGIF(maxDuration int, filters ...ImageFilter) ([]byte, error)

Renders a screen to GIF. Optionally pass filters for postprocessing each individual frame.

func (*Screens) EncodeWebP

func (s *Screens) EncodeWebP(maxDuration int, filters ...ImageFilter) ([]byte, error)

Renders a screen to WebP. Optionally pass filters for postprocessing each individual frame.

func (*Screens) Hash

func (s *Screens) Hash() ([]byte, error)

Hash returns a hash of the render roots for this screen. This can be used for testing whether two render trees are exactly equivalent, without having to do the actual rendering.