@asdf-overlay/electron 0.9.1 → 0.9.2

package/lib/index.d.ts

@@ -1,5 +1,14 @@
 import type { Overlay } from '@asdf-overlay/core';
+/**
+ * Describe a window in `Overlay`.
+ */
 export type OverlayWindow = {
+    /**
+     * Associated `Overlay` instance.
+     */
     overlay: Overlay;
+    /**
+     * Window id.
+     */
     id: number;
 };

package/lib/input/conv.d.ts

@@ -1,3 +1,17 @@
 import { Cursor } from '@asdf-overlay/core';
+/**
+ * Map CSS cursor into overlay `Cursor`.
+ *
+ * Invalid CSS cursors will be mapped to `Default`.
+ *
+ * @see https://developer.mozilla.org/ko/docs/Web/CSS/cursor
+ * @see https://www.electronjs.org/docs/latest/api/web-contents
+ */
 export declare function mapCssCursor(cursor: string): Cursor | undefined;
+/**
+ * Map Windows virtual key code into Electron accelerator keycode.
+ *
+ * @see https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
+ * @see https://www.electronjs.org/docs/latest/api/accelerator
+ */
 export declare function mapKeycode(code: number): string | undefined;

package/lib/input/conv.js

@@ -1,6 +1,12 @@
 import { Cursor } from '@asdf-overlay/core';
-// https://www.electronjs.org/docs/latest/api/web-contents
-// https://developer.mozilla.org/ko/docs/Web/CSS/cursor
+/**
+ * Map CSS cursor into overlay `Cursor`.
+ *
+ * Invalid CSS cursors will be mapped to `Default`.
+ *
+ * @see https://developer.mozilla.org/ko/docs/Web/CSS/cursor
+ * @see https://www.electronjs.org/docs/latest/api/web-contents
+ */
 export function mapCssCursor(cursor) {
     switch (cursor) {
         case 'pointer': return Cursor.Default;
@@ -50,11 +56,18 @@ export function mapCssCursor(cursor) {
         default: return Cursor.Default;
     }
 }
+/**
+ * Map Windows virtual key code into Electron accelerator keycode.
+ *
+ * @see https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
+ * @see https://www.electronjs.org/docs/latest/api/accelerator
+ */
 export function mapKeycode(code) {
     return KEYS[code];
 }
-// As per https://www.electronjs.org/docs/latest/api/accelerator
-// and https://learn.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
+/**
+ * Conversion map from windows keycode to Electron accelerator keycode.
+ */
 const KEYS = {
     8: 'Backspace',
     9: 'Tab',

package/lib/input.d.ts

@@ -1,6 +1,9 @@
 import type { WebContents } from 'electron';
 import type { OverlayWindow } from './index.js';
 import type { CursorInput, KeyboardInput } from '@asdf-overlay/core/input';
+/**
+ * Connection from a overlay window to a Electron window.
+ */
 export declare class ElectronOverlayInput {
     private readonly window;
     private readonly contents;
@@ -8,7 +11,13 @@ export declare class ElectronOverlayInput {
     private readonly keyboardInputHandler;
     private readonly cursorChangedHandler;
     private constructor();
+    /**
+     * Connect overlay inputs to a Electron `WebContents`.
+     */
     static connect(window: OverlayWindow, contents: WebContents): ElectronOverlayInput;
+    /**
+     * Disconnect overlay inputs.
+     */
     disconnect(): Promise<void>;
     private readonly clickCounts;
     private processCursorAction;

package/lib/input.js

@@ -1,5 +1,8 @@
 import { mapCssCursor, mapKeycode } from './input/conv.js';
 import { Cursor } from '@asdf-overlay/core';
+/**
+ * Connection from a overlay window to a Electron window.
+ */
 export class ElectronOverlayInput {
     window;
     contents;
@@ -26,9 +29,15 @@ export class ElectronOverlayInput {
             void this.window.overlay.setBlockingCursor(this.window.id, mapCssCursor(type));
         });
     }
+    /**
+     * Connect overlay inputs to a Electron `WebContents`.
+     */
     static connect(window, contents) {
         return new ElectronOverlayInput({ ...window }, contents);
     }
+    /**
+     * Disconnect overlay inputs.
+     */
     async disconnect() {
         this.window.overlay.event.off('cursor_input', this.cursorInputHandler);
         this.window.overlay.event.off('keyboard_input', this.keyboardInputHandler);

package/lib/surface.d.ts

@@ -2,17 +2,38 @@ import type { WebContents } from 'electron';
 import type { OverlayWindow } from './index.js';
 import EventEmitter from 'node:events';
 type Emitter = EventEmitter<{
+    /**
+     * An error has been occured while copying to overlay surface.
+     */
     error: [e: unknown];
 }>;
+/**
+ * Connection from a Electron offscreen window to a overlay surface.
+ */
 export declare class ElectronOverlaySurface {
     private readonly window;
     private readonly contents;
+    /**
+     * Events during paints.
+     */
     readonly events: Emitter;
     private handler;
     private constructor();
+    /**
+     * Connect Electron `WebContents` surface to target overlay window.
+     */
     static connect(window: OverlayWindow, contents: WebContents): ElectronOverlaySurface;
+    /**
+     * Disconnect surface from Electron window and clear overlay surface.
+     */
     disconnect(): Promise<void>;
+    /**
+     * Copy overlay texture in gpu accelerated shared texture mode.
+     */
     private paintAccelerated;
+    /**
+     * Copy overlay texture from bitmap surface.
+     */
     private paintSoftware;
     private emitError;
 }

package/lib/surface.js

@@ -1,7 +1,13 @@
 import EventEmitter from 'node:events';
+/**
+ * Connection from a Electron offscreen window to a overlay surface.
+ */
 export class ElectronOverlaySurface {
     window;
     contents;
+    /**
+     * Events during paints.
+     */
     events = new EventEmitter();
     handler;
     constructor(window, contents) {
@@ -26,13 +32,22 @@ export class ElectronOverlaySurface {
         contents.on('paint', this.handler);
         contents.invalidate();
     }
+    /**
+     * Connect Electron `WebContents` surface to target overlay window.
+     */
     static connect(window, contents) {
         return new ElectronOverlaySurface({ ...window }, contents);
     }
+    /**
+     * Disconnect surface from Electron window and clear overlay surface.
+     */
     async disconnect() {
         this.contents.off('paint', this.handler);
         await this.window.overlay.clearSurface(this.window.id);
     }
+    /**
+     * Copy overlay texture in gpu accelerated shared texture mode.
+     */
     async paintAccelerated(texture) {
         const rect = texture.metadata.captureUpdateRect ?? texture.contentRect;
         // update only changed part
@@ -47,6 +62,9 @@ export class ElectronOverlaySurface {
             this.emitError(e);
         }
     }
+    /**
+     * Copy overlay texture from bitmap surface.
+     */
     async paintSoftware(_dirtyRect, image) {
         // TODO:: update only changed part
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asdf-overlay/electron",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "Asdf overlay Electron integration",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -34,7 +34,7 @@
   },
   "peerDependencies": {
     "electron": "^37.3.1",
-    "@asdf-overlay/core": "0.9.0"
+    "@asdf-overlay/core": "0.9.2"
   },
   "scripts": {
     "build:dist": "tsc",