class Screenshot

Defined at line 10018 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/hlcpp/fuchsia/ui/composition/cpp/fidl.h

Collects the current graphical content of a display.

Public Members

static const char[] Name_

Public Methods

void ~Screenshot ()
void Take (::fuchsia::ui::composition::ScreenshotTakeRequest ScreenshotTakeRequest, TakeCallback callback)

Collects the current graphical content of a display in a specified buffer `format` in the

sRGB color space. Note that the sRGB color space is non-linear, meaning that unit tests

doing pixel equality checks making use of non-fully saturated colors should convert to a

linear color space.

See https://fuchsia.dev/fuchsia-src/concepts/ui/scenic/color_spaces for more information.

Screenshot is taken immediately, populated with the display's content from the most recent

VSYNC.

If the client calls [`Take`] a second time before a first [`Take`] call returns, the server

will close the Screenshot connection with a ZX_ERR_SHOULD_WAIT epitaph.

If capture fails due to an internal error, the server will close the Screenshot connection

with a ZX_ERR_INTERNAL epitaph.

void TakeFile (::fuchsia::ui::composition::ScreenshotTakeFileRequest ScreenshotTakeFileRequest, TakeFileCallback callback)

Collects the current graphical content of a display in a specified buffer `format` in the

sRGB color space. Note that the sRGB color space is non-linear, meaning that unit tests

doing pixel equality checks making use of non-fully saturated colors should convert to a

linear color space.

TODO(https://fxbug.dev/42065844): Link to fuchsia.dev documentation when it's up.

Screenshot is taken immediately, populated with the display's content from the most recent

VSYNC.

If the client calls [`TakeFile`] a second time before a first [`TakeFile`] call returns,

the server will close the Screenshot connection with a ZX_ERR_SHOULD_WAIT epitaph.

If capture fails due to an internal error, the server will close the Screenshot connection

with a ZX_ERR_INTERNAL epitaph.

This call should be used if the client is on the host and does not support VMOs,

as is the case for ffx tools.