#include <Screenshot.h>
◆ ScreenshotError
Why a screenshot did not happen, so a caller can say which.
| Enumerator |
|---|
| NONE | |
| NO_FOLDER | no screenshot folder is configured
|
| BAD_TARGET | the requested name is not a plain .png file name
|
| NOT_FOUND | the named screenshot is not in the folder
|
| FAILED | the frame did not arrive, or a file could not be written
|
◆ CreateSurface()
Create the platform's capture readback surface, null when none registered.
◆ DeleteScreenshots()
Delete screenshots from the configured folder.
- Parameters
-
| file | one screenshot, named as TakeScreenshotSync answers or as a bare name; every .png in the folder when empty |
◆ IsScreenshotPath()
| bool CScreenShot::IsScreenshotPath |
( |
const std::string & | path | ) |
|
|
static |
Whether a path names a screenshot: the special://screenshots folder and a plain .png name. None does while no screenshot folder is configured.
◆ JoinedScreenshotCalls()
| int CScreenShot::JoinedScreenshotCalls |
( |
| ) |
|
|
static |
◆ Register()
◆ SetMoveHook()
| void CScreenShot::SetMoveHook |
( |
std::function< void()> | hook | ) |
|
|
static |
Have hook called as a synchronous screenshot starts moving its files into place.
◆ TakeScreenshot() [1/3]
| void CScreenShot::TakeScreenshot |
( |
| ) |
|
|
static |
◆ TakeScreenshot() [2/3]
◆ TakeScreenshot() [3/3]
Screenshot of the given content into the configured folder.
◆ TakeScreenshotBoth()
| void CScreenShot::TakeScreenshotBoth |
( |
| ) |
|
|
static |
Capture the video-only image and the full composite from the same rendered frame into two files in the configured folder (screenshotNNNNN.png and screenshotNNNNN-video.png).
◆ TakeScreenshotSync()
Screenshot of the given content, written before this returns; an unset folder is NO_FOLDER, never a prompt. A call made while another is in flight takes none of its own: it waits for that one and answers its result, whatever it asked for.
- Parameters
-
| content | what to capture |
| target | file name under the configured folder, auto-numbered when empty; the video frame takes the matching "-video" name |
The documentation for this class was generated from the following files: