Back to Aframe

screenshot

docs/components/screenshot.md

1.7.11.5 KB
Original Source

The screenshot component lets us take different types of screenshots with keyboard shortcuts. A-Frame attaches this component to the scene by default so we don't have to do anything to use the component.

Shortcuts

Equirectangular Screenshot

To take a 360° (equirectangular) screenshot, press <ctrl> + <alt> + <shift> + s on the keyboard.

Perspective Screenshot

To take a normal (perspective) screenshot, press <ctrl> + <alt> + s on the keyboard.

Properties

PropertyDescriptionDefault Value
widthThe width in pixels of the screenshot taken.4096
heightThe height in pixels of the screenshot taken.2048

Methods

To take a screenshot programmatically and get a canvas, call getCanvas():

js
// `screenshot.projection` property can be `equirectangular` or `perspective`.
document.querySelector('a-scene').components.screenshot.getCanvas('equirectangular');

To take a screenshot programmatically and automatically save the file, call capture():

js
document.querySelector('a-scene').components.screenshot.capture('perspective')