Struct ScreenshotProxy

pub struct ScreenshotProxy { /* private fields */ }

Implementations

impl ScreenshotProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.composition/Screenshot.

pub fn take_event_stream(&self) -> ScreenshotEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn take( &self, payload: ScreenshotTakeRequest, ) -> QueryResponseFut<ScreenshotTakeResponse, DefaultFuchsiaResourceDialect>

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.

pub fn take_file( &self, payload: ScreenshotTakeFileRequest, ) -> QueryResponseFut<ScreenshotTakeFileResponse, DefaultFuchsiaResourceDialect>

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.

Trait Implementations

impl Clone for ScreenshotProxy

fn clone(&self) -> ScreenshotProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScreenshotProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Proxy for ScreenshotProxy

type Protocol = ScreenshotMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

impl ScreenshotProxyInterface for ScreenshotProxy

type TakeResponseFut = QueryResponseFut<ScreenshotTakeResponse>

type TakeFileResponseFut = QueryResponseFut<ScreenshotTakeFileResponse>

fn take(&self, payload: ScreenshotTakeRequest) -> Self::TakeResponseFut

fn take_file( &self, payload: ScreenshotTakeFileRequest, ) -> Self::TakeFileResponseFut