StudioScreenshotCapture

Not yet Class GUI NotCreatable NotReplicated

Represents a single screenshot captured from Studio, exposing the resulting image buffer and the parameters the capture was taken with.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 15 modern Roblox members not implemented yet

Description

Studio-only capture result that requires plugin security — not available in published experiences. Produced by CaptureScreenshot() and CapturePluginGui(). It holds the encoded image data together with the region and format used for the capture, and reports progress through BufferStatus.

The image is populated asynchronously. BufferStatus defaults to StudioCaptureBufferStatus.NotStarted, becomes StudioCaptureBufferStatus.Pending while capturing and encoding, StudioCaptureBufferStatus.Ready once the image is available, or StudioCaptureBufferStatus.Error if capture failed. Retrieve the image with GetBuffer(), read failure details with GetErrors(), and produce a resized copy with ScaleAsync().

Inheritance

Object → Instance → StudioScreenshotCapture

Properties

Member	Signature	Summary
BufferFormat	BufferFormat: StudioCaptureScreenshotFormat	The pixel format of the image data returned by GetBuffer().
BufferStatus	BufferStatus: StudioCaptureBufferStatus	Reflects the current state of the capture as its image data is produced.
OriginalSize	OriginalSize: Vector2	The size, in pixels, of the region available for capture from Position to the edge of the Studio view.
Position	Position: Vector2	The top-left corner, in pixels, of the captured region within the Studio view.
Resolution	Resolution: Vector2	The pixel dimensions of the captured image.
UICaptureMode	UICaptureMode: UICaptureMode	Indicates which user-interface layers were included in the capture.

Methods

Member	Signature	Summary
GetBuffer	StudioScreenshotCapture:GetBuffer(): buffer	Returns the captured image data as a buffer in the capture's pixel format.
GetErrors	StudioScreenshotCapture:GetErrors(): Array	Returns an array of error messages recorded during the capture.
ScaleAsync	StudioScreenshotCapture:ScaleAsync(strategy: ResamplerMode, newSize: Vector2): StudioScreenshotCapture	Produces a new capture containing a resized copy of this capture's image.

Roblox reference: StudioScreenshotCapture

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.