ScreenshotKit Runtime API Overview

A tour of every type in the DaCruz.ScreenshotKit namespace and guidance on when to use the Runtime API versus the Editor window.

Use the Runtime API when you want to drive captures from your own scripts at runtime: a hotkey in a built game, an in-game photo mode, or an automated capture pass at the end of a scene.

All types live in the DaCruz.ScreenshotKit namespace, in the DaCruz.ScreenshotKit runtime assembly.

The types

Type	What it does
ScreenshotCapture	Static capture methods: single shots, transparent capture, capture with mattes, sequence frames. See Capture.
ScreenshotKitAPI	One-line convenience wrapper: CaptureScreenshot() with optional settings and camera.
ScreenshotKitCapture	A MonoBehaviour component with an in-game hotkey, for no-code captures in builds. See Runtime Component.
ScreenshotSettings	The ScriptableObject holding resolution, format, filename, matte, and panorama settings.
CryptomatteCapture	Direct access to individual matte textures (normals, depth, IDs, and so on). See Capture with Mattes.
PanoramaCapture	PanoramaCapture.Capture(camera, settings) renders a mono or stereo equirectangular panorama.
GifRecorder	Singleton GIF recorder with threaded encoding and progress events. See GifRecorder.
SequenceRecorder	Singleton frame-by-frame image sequence recorder. See SequenceRecorder.

Video recording (the Record tab) is editor-driven: encoding runs through the editor’s media backend, so there is no runtime API for writing MP4 / WebM files from a build.

Editor window or API?

• Capturing while authoring scenes: use the window, it is faster.
• Capturing in a built game, from gameplay code, or on a schedule: use the API.
• Both share the same ScreenshotSettings asset, so filenames, formats, and matte selections stay consistent.