CaptureSceneTask

OpalTask that captures one registered scene, or a closeup of one part of it.


Inherits	OpalTask
Group	catalog

Declared in src/libs/libcatalog/opal/CaptureSceneTask.hpp.

Detailed description

Wraps SceneScreenshotService::render() as the task catalog.capture-scene (white-label-docs §WLO-S6). The arguments are the keys of a screenshot: reference of a page, so a model can see the image that a page shows:

scene (required): the id of the scene in SceneRegistry.
mode: the variation of the scene. The default is default.
focus: the anchor of a closeup. The image shows that widget and the margin around it.
margin: the margin of the closeup, in logical pixels. The default is 16.
callout: the anchors of the numbered callouts, as a list or as one comma-separated string.
dpr: the device pixel ratio of the render. The default is 1.
output-dir: a folder for the PNG file. The default is the capture folder of the OPAL vision tasks.

The result carries the marked image as an attachment, and its path as the output output-path. A failed capture, such as a focus anchor that is hidden or a visible scroll bar, fails the task with the reason.