(#278) Added grab and grabRegion methods to Screen

Author: s1hofmann

lib/screen.class.e2e.spec.ts

@@ -4,6 +4,7 @@ import {FileType} from "./file-type.enum";
 import {ScreenClass} from "./screen.class";
 import {sleep} from "./sleep.function";
 import AbortController from "node-abort-controller";
+import {Region} from "./region.class";
 
 jest.setTimeout(10000);
 
@@ -135,4 +136,35 @@ describe("Screen.", () => {
         });
         setTimeout(() => controller.abort(), abortAfterMs);
     });
+
+    it("should grab the whole screen content and return an Image", async () => {
+        // GIVEN
+        const visionAdapter = new VisionAdapter();
+        const SUT = new ScreenClass(visionAdapter);
+        const screenWidth = await SUT.width();
+        const screenHeight = await SUT.height();
+
+        // WHEN
+        const image = await SUT.grab();
+
+        // THEN
+        expect(image.data).not.toBeUndefined();
+        expect(image.width / image.pixelDensity.scaleX).toBe(screenWidth);
+        expect(image.height / image.pixelDensity.scaleY).toBe(screenHeight);
+    });
+
+    it("should grab a screen region and return an Image", async () => {
+        // GIVEN
+        const visionAdapter = new VisionAdapter();
+        const SUT = new ScreenClass(visionAdapter);
+        const regionToGrab = new Region(0, 0, 100, 100);
+
+        // WHEN
+        const image = await SUT.grabRegion(regionToGrab);
+
+        // THEN
+        expect(image.data).not.toBeUndefined();
+        expect(image.width / image.pixelDensity.scaleX).toBe(regionToGrab.width);
+        expect(image.height / image.pixelDensity.scaleY).toBe(regionToGrab.height);
+    });
 });

lib/screen.class.ts

@@ -208,6 +208,13 @@ export class ScreenClass {
             fileNamePostfix);
     }
 
+    /**
+     * {@link grab} grabs screen content of a systems main display
+     */
+    public async grab(): Promise<Image> {
+        return this.vision.grabScreen();
+    }
+
     /**
      * {@link captureRegion} captures a screenshot of a region on the systems main display
      * @param fileName Basename for the generated screenshot
@@ -234,6 +241,13 @@ export class ScreenClass {
             fileNamePostfix);
     }
 
+    /**
+     * {@link grabRegion} grabs screen content of a region on the systems main display
+     */
+    public async grabRegion(regionToGrab: Region): Promise<Image> {
+        return this.vision.grabScreenRegion(regionToGrab);
+    }
+
     private async saveImage(
         image: Image,
         fileName: string,