NDEVR
API Documentation
ScreenshotRequest

Encapsulates a request to capture a screenshot, along with a callback to receive the resulting image identifier. More...

Public Member Functions

 ScreenshotRequest ()
 Default constructor.
 ScreenshotRequest (std::function< void(const StringView &image_id)> callback)
 Constructs a ScreenshotRequest with the given completion callback.
bool operator!= (const ScreenshotRequest &) const
 Inequality operator.
bool operator== (const ScreenshotRequest &) const
 Equality operator.

Public Attributes

std::function< void(const StringView &image_id)> callback
 Callback invoked with the screenshot image identifier upon completion.

Detailed Description

Encapsulates a request to capture a screenshot, along with a callback to receive the resulting image identifier.


Definition at line 56 of file Camera.h.

Constructor & Destructor Documentation

◆ ScreenshotRequest()

ScreenshotRequest::ScreenshotRequest ( std::function< void(const StringView &image_id)> callback)
inline

Constructs a ScreenshotRequest with the given completion callback.

Parameters
[in]callbackFunction invoked with the image identifier once the screenshot is captured.

Definition at line 67 of file Camera.h.

References callback.

Member Function Documentation

◆ operator!=()

bool ScreenshotRequest::operator!= ( const ScreenshotRequest & ) const
inline

Inequality operator.

Always returns true since each request is considered unique.

Returns
True.

Definition at line 82 of file Camera.h.

References ScreenshotRequest().

◆ operator==()

bool ScreenshotRequest::operator== ( const ScreenshotRequest & ) const
inline

Equality operator.

Always returns false since each request is considered unique.

Returns
False.

Definition at line 74 of file Camera.h.

References ScreenshotRequest().


The documentation for this struct was generated from the following file: