engine

Oct 18, 2026

Changes in this version

type Engine

+ FontFaces []LoadedFontFace

type LoadedFontFace

+ func ParseFontFace(family string, weight int, italic bool, data []byte) (LoadedFontFace, error)

Oct 18, 2026

Changes in this version

type Engine

+ DeviceScale float64

Oct 18, 2026

Changes in this version

type Engine

+ FileRoot string

Oct 4, 2026

Changes in this version

+ var ErrClosed = errors.New("engine: LiveDocument is closed")

+ func DocumentIDs(root *layout.Box) map[string]Anchor

+ func ElementAt(index map[*dom.Node]layout.Rect, pt image.Point) (*dom.Node, bool)

+ func ElementsFromBox(root *layout.Box) map[*dom.Node]layout.Rect

+ func RasterizeSVG(data []byte, w, h int, currentColor string) (img image.Image, ok bool)

+ func RegisterFontFaces(fonts *paint.Fonts, faces []LoadedFontFace) int

+ type Anchor struct

+ X float64

+ Y float64

type Engine

+ func (e *Engine) LoadFontFaces(ctx context.Context, doc *Document, sheets []string, m css.Media) []LoadedFontFace

+ func (e *Engine) LoadImageSet(ctx context.Context, doc *Document, sm css.StyleMap, viewportW int) map[*dom.Node]*LoadedImage

+ func (e *Engine) LoadImages(ctx context.Context, doc *Document, sm css.StyleMap, viewportW int) (map[*dom.Node][2]float64, map[*dom.Node]image.Image)

+ func (e *Engine) LoadStylesheets(ctx context.Context, doc *Document, m css.Media) []string

+ func (e *Engine) Open(ctx context.Context, rawurl string, viewport image.Rectangle) (*LiveDocument, error)

+ func (e *Engine) OpenDocument(ctx context.Context, doc *Document, viewport image.Rectangle) (*LiveDocument, error)

+ type Heading struct

+ Level int

+ Node *dom.Node

+ Title string

+ Y float64

+ func Headings(root *layout.Box) []Heading

+ type LinkRun struct

+ Fragment string

+ H float64

+ Node *dom.Node

+ URI string

+ W float64

+ X float64

+ Y float64

+ func LinkRuns(root *layout.Box, base *url.URL, ids map[string]struct{}) []LinkRun

+ type LiveDocument struct

+ func (d *LiveDocument) Backspace(ctx context.Context, n *dom.Node) (*image.RGBA, *RenderInfo, error)

+ func (d *LiveDocument) Blur(ctx context.Context) (*image.RGBA, *RenderInfo, error)

+ func (d *LiveDocument) Click(ctx context.Context, n *dom.Node) (defaultPrevented bool, img *image.RGBA, info *RenderInfo, err error)

+ func (d *LiveDocument) Close()

+ func (d *LiveDocument) Document() *Document

+ func (d *LiveDocument) ElementAt(pt image.Point) (*dom.Node, bool)

+ func (d *LiveDocument) Elements() map[*dom.Node]layout.Rect

+ func (d *LiveDocument) Eval(code string) (interface{}, error)

+ func (d *LiveDocument) Focus(ctx context.Context, n *dom.Node) (*image.RGBA, *RenderInfo, error)

+ func (d *LiveDocument) Frame() (*image.RGBA, *RenderInfo, error)

+ func (d *LiveDocument) Interact(ctx context.Context, fn func()) (*image.RGBA, *RenderInfo, error)

+ func (d *LiveDocument) KeyDown(ctx context.Context, n *dom.Node, key string) (defaultPrevented bool, img *image.RGBA, info *RenderInfo, err error)

+ func (d *LiveDocument) Submit(ctx context.Context, form *dom.Node) (next *LiveDocument, navigated bool, err error)

+ func (d *LiveDocument) Type(ctx context.Context, n *dom.Node, text string) (img *image.RGBA, info *RenderInfo, err error)

+ type LoadedFontFace struct

+ Data []byte

+ Family string

+ Italic bool

+ URL string

+ Weight int

+ type LoadedImage struct

+ Bitmap image.Image

+ Data []byte

+ Format string

+ Lossy bool

+ Size [2]float64

+ SourceH int

+ SourceW int

Aug 11, 2026

Changes in this version

type Engine

+ ImageCache ImageCache

+ type ImageCache interface

+ Get func(url string) ([]byte, bool)

+ Put func(url string, data []byte)

Aug 10, 2026

Changes in this version

type Engine

+ Backdrop css.Color

Aug 9, 2026

Changes in this version

type Engine

+ MaxJSHeapBytes int64

Aug 8, 2026

Changes in this version

type Engine

+ MetaFallback bool

Aug 8, 2026

Changes in this version

type Engine

+ MaxVectorImages int

Aug 7, 2026

Changes in this version

type Engine

+ func (e *Engine) RenderDocumentProgressive(ctx context.Context, doc *Document, viewport image.Rectangle, ...) (*RenderInfo, error)

+ func (e *Engine) RenderProgressive(ctx context.Context, rawurl string, viewport image.Rectangle, ...) (*RenderInfo, error)

+ type ProgressiveFrame struct

+ Final bool

+ Img *image.RGBA

+ Info *RenderInfo

+ Links []Link

+ Stage string

Aug 7, 2026

Changes in this version

+ func EncodePNG(img image.Image) ([]byte, error)

+ func LinkAt(links []Link, pt image.Point) (string, bool)

+ func Screenshot(ctx context.Context, rawurl string, viewport image.Rectangle) ([]byte, error)

+ type Document struct

+ HTML string

+ Root *dom.Node

+ Title string

+ URL string

+ type Engine struct

+ Client *http.Client

+ DisableJS bool

+ JSLog func(string)

+ JSTimeout time.Duration

+ MaxImages int

+ UserAgent string

+ func New() *Engine

+ func (e *Engine) Fetch(ctx context.Context, rawurl string) (*Document, error)

+ func (e *Engine) Render(ctx context.Context, rawurl string, viewport image.Rectangle) (*image.RGBA, *RenderInfo, error)

+ func (e *Engine) RenderDocument(ctx context.Context, doc *Document, viewport image.Rectangle) (*image.RGBA, *RenderInfo, error)

+ func (e *Engine) RenderDocumentWithLinks(ctx context.Context, doc *Document, viewport image.Rectangle) (*image.RGBA, *RenderInfo, []Link, error)

+ func (e *Engine) RenderHTML(ctx context.Context, htmlSrc, baseURL string, viewport image.Rectangle) (*image.RGBA, *RenderInfo, error)

+ func (e *Engine) RenderWithLinks(ctx context.Context, rawurl string, viewport image.Rectangle) (*image.RGBA, *RenderInfo, []Link, error)

+ func (e *Engine) Screenshot(ctx context.Context, rawurl string, viewport image.Rectangle) ([]byte, error)

+ type Link struct

+ Href string

+ Rect image.Rectangle

+ func LinksFromBox(root *layout.Box, baseURL string) []Link

+ type RenderInfo struct

+ ContentHeight int

+ Title string

+ URL string

+ func Render(ctx context.Context, rawurl string, viewport image.Rectangle) (*image.RGBA, *RenderInfo, error)