ScreenClass class constructor
A ProviderRegistry used to access underlying implementations
A {@link Map} of FindHookCallback methods assigned to a template image
Config object for ScreenClass class
capture captures a screenshot of a systems main display
Basename for the generated screenshot
The FileType for the generated screenshot
The output path for the generated screenshot (Default: {@link cwd})
Filename prefix for the generated screenshot (Default: empty)
Filename postfix for the generated screenshot (Default: empty)
captureRegion captures a screenshot of a region on the systems main display
Basename for the generated screenshot
The region of the screen to capture in the screenshot
The FileType for the generated screenshot
The output path for the generated screenshot (Default: {@link cwd})
Filename prefix for the generated screenshot (Default: empty)
Filename postfix for the generated screenshot (Default: empty)
find will search for a single occurrence of a template image on a systems main screen
Template Image instance
{@link LocationParameters} which are used to fine tune search region and / or match confidence
findAll will search for every occurrences of a template image on a systems main screen
Template Image instance
{@link LocationParameters} which are used to fine tune search region and / or match confidence
grabRegion grabs screen content of a region on the systems main display
height returns the main screen height This refers to the hardware resolution. Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher height in in actual pixels
on registers a callback which is triggered once a certain template image is found
Template image to trigger the callback on
The FindHookCallback function to trigger
waitFor searches for a template image for a specified duration
Filename of the template image, relative to {@link ScreenClass.config.resourceDirectory}, or an Image
Timeout in milliseconds after which waitFor fails
Update interval in milliseconds to retry search
{@link LocationParameters} which are used to fine tune search region and / or match confidence
width returns the main screen width This refers to the hardware resolution. Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher width in in actual pixels
ScreenClass class provides methods to access screen content of a systems main display