---
name: "canvas::snap"
section: "3tk"
platform: "linux"
package: "tklib"
version: "0.9-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/canvas::snap"
---

# canvas::snap(3tk)

Canvas snapshot to Tk photo image

```

```

## NAME

canvas::snap - Canvas snapshot to Tk photo image

## SYNOPSIS

package require **Tcl 8.5**

package require **Tk 8.5**

package require **canvas::snap ?1.0.1?**

package require **img::window**

**::canvas::snap** *pathName*

```

```

## DESCRIPTION

This package provides a command to take snapshots of arbitrary canvases.

## API

- **::canvas::snap** *pathName*

  Takes a snapshot of the canvas *pathName*. The result is the name of a new Tk photo image containing the snapshot.

  *Note* that this command has a side-effect. To avoid having white rectangles where other windows may overlap the canvas this command forces the toplevel window the canvas is in to the top of the stacking order.

## BUGS, IDEAS, FEEDBACK

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category *canvas* of the *Tklib Trackers* \[http://core.tcl.tk/tklib/reportlist\]. Please also report any ideas for enhancements you may have for either package and/or documentation.

## KEYWORDS

canvas, image, photo, print screen, snapshot

## COPYRIGHT

```
Copyright (c) 2004 George Petasis (http://wiki.tcl.tk/1404)
Copyright (c) 2010 Documentation, Andreas Kupries
```