engine.grabber Functions

List of functions:

The functions described below are available when the AppGrabber is enabled.

If the plugin is loaded together with the engine, the
HAS_APP_GRABBER definition is set.
This definition can be used, for example, to avoid errors if the plugin is not loaded: the code in which the plugin functions are executed can be wrapped around as follows:

Source code (UnigineScript)

#ifdef HAS_APP_GRABBER
// engine.grabber functions
#endif

intengine.grabber.getGui()

Returns the value indicating whether the main GUI should be grabbed or not.

Return value

1 to grab the main GUI; otherwise, 0.

intengine.grabber.getHeight()

Returns the height of the grabbed snapshot.

Return value

Height of the snapshot.

Imageengine.grabber.getImage()

Returns the snapshot of the current viewport, which is grabbed by the AppGrabber each frame.