This page has been translated automatically.
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
High-Level Systems
Usage Examples
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

engine.grabber Functions

The functions described below are available when the AppGrabber plugin is loaded.

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)
	// engine.grabber functions

int engine.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.

int engine.grabber.getHeight ()

Returns the height of the grabbed snapshot.

Return value

Height of the snapshot.

Image engine.grabber.getImage ()

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

Return value

Image which is the snapshot of the current viewport.

int engine.grabber.getWidth ()

Returns the width of the grabbed snapshot.

Return value

Width of the snapshot.
Last update: 2017-07-03
Build: ()