object.canvasMode

Type String
Object SnapshotObject
Library display.*
Revision Release 2024.3703
Keywords canvas, canvasMode
See also display.newSnapshot()
snapshot.canvas

Overview

The canvas mode controls what happens to the children of the snapshot's canvas.

This mode comes into play when the canvas is invalidated (i.e. calling snapshot:invalidate("canvas")). On the next render pass, the children will be removed from the canvas. The mode controls where those children go:

Syntax

snapshot.canvasMode