@asdf-overlay/core 0.9.7 → 1.0.0

package/lib/addon.d.ts

@@ -1,16 +1,19 @@
 import { OverlayEventEmitter } from './index.js';
-import { CopyRect, Cursor, PercentLength } from './types.js';
+import { CopyRect, Cursor, PercentLength, type GpuLuid, type UpdateSharedHandle } from './types.js';
 export type Addon = {
     attach(dllDir: string, pid: number, timeout?: number): Promise<number>;
     overlaySetPosition(id: number, winId: number, x: PercentLength, y: PercentLength): Promise<void>;
     overlaySetAnchor(id: number, winId: number, x: PercentLength, y: PercentLength): Promise<void>;
     overlaySetMargin(id: number, winId: number, top: PercentLength, right: PercentLength, bottom: PercentLength, left: PercentLength): Promise<void>;
+    overlayUpdateHandle(id: number, winId: number, update: UpdateSharedHandle): Promise<void>;
     overlayListenInput(id: number, winId: number, cursor: boolean, keyboard: boolean): Promise<void>;
     overlayBlockInput(id: number, winId: number, block: boolean): Promise<void>;
     overlaySetBlockingCursor(id: number, winId: number, cursor?: Cursor): Promise<void>;
-    overlayUpdateBitmap(id: number, winId: number, width: number, data: Buffer): Promise<void>;
-    overlayUpdateShtex(id: number, winId: number, width: number, height: number, handle: Buffer, rect?: CopyRect): Promise<void>;
-    overlayClearSurface(id: number, winId: number): Promise<void>;
     overlayCallNextEvent(id: number, emitter: OverlayEventEmitter, emit: OverlayEventEmitter['emit']): Promise<boolean>;
     overlayDestroy(id: number): void;
+    surfaceCreate(luid: GpuLuid): number;
+    surfaceClear(id: number): void;
+    surfaceUpdateBitmap(id: number, width: number, data: Buffer): UpdateSharedHandle | null;
+    surfaceUpdateShtex(id: number, width: number, height: number, handle: Buffer, rect?: CopyRect): UpdateSharedHandle | null;
+    surfaceDestroy(id: number): void;
 };

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'node:events';
 import { CursorInput, KeyboardInput } from './input.js';
-import { PercentLength, CopyRect, Cursor } from './types.js';
+import { PercentLength, CopyRect, Cursor, type UpdateSharedHandle, type GpuLuid } from './types.js';
 export * from './types.js';
 export * from './util.js';
 /**
@@ -11,7 +11,7 @@ export type OverlayEventEmitter = EventEmitter<{
     /**
      * A window has been added.
      */
-    added: [id: number, width: number, height: number];
+    added: [id: number, width: number, height: number, luid: GpuLuid];
     /**
      * A window has been resized.
      */
@@ -88,40 +88,59 @@ export declare class Overlay {
      */
     setBlockingCursor(id: number, cursor?: Cursor): Promise<void>;
     /**
-     * Update overlay using bitmap buffer. The size of overlay is `width x (data.byteLength / 4 / width)`
+     * Update overlay surface.
      * @param id target window id
+     * @param update shared handle update
+     */
+    updateHandle(id: number, update: UpdateSharedHandle): Promise<void>;
+    /**
+     * Destroy overlay
+     */
+    destroy(): void;
+    /**
+     * Attach overlay to target process
+     *
+     * Name must be unique or it will fail if there is a connection with same name
+     * @param dllDir path to dlls
+     * @param pid target process pid
+     * @param timeout Timeout for injection, in milliseconds. Will wait indefinitely if not provided.
+     * @returns new {@link Overlay} object
+     */
+    static attach(dllDir: string, pid: number, timeout?: number): Promise<Overlay>;
+}
+/**
+ * Represent a surface for overlay.
+ */
+export declare class OverlaySurface {
+    readonly [idSym]: number;
+    private constructor();
+    /**
+     * Update surface using bitmap buffer. The size of overlay is `width x (data.byteLength / 4 / width)`
      * @param width width of the bitmap
      * @param data bgra formatted bitmap
      */
-    updateBitmap(id: number, width: number, data: Buffer): Promise<void>;
+    updateBitmap(width: number, data: Buffer): UpdateSharedHandle | null;
     /**
-     * Update overlay using D3D11 shared texture.
-     * @param id target window id
+     * Update surface using D3D11 shared texture.
      * @param width width of the surface
      * @param height height of the surface
      * @param handle NT Handle of shared D3D11 Texture
      * @param rect Area to update
      */
-    updateShtex(id: number, width: number, height: number, handle: Buffer, rect?: CopyRect): Promise<void>;
+    updateShtex(width: number, height: number, handle: Buffer, rect?: CopyRect): UpdateSharedHandle | null;
     /**
-     * Clear overlay
-     * @param id target window id
+     * Clear the surface.
      */
-    clearSurface(id: number): Promise<void>;
+    clear(): void;
     /**
-     * Destroy overlay
+     * Destroy the surface.
      */
     destroy(): void;
     /**
-     * Attach overlay to target process
-     *
-     * Name must be unique or it will fail if there is a connection with same name
-     * @param dllDir path to dlls
-     * @param pid target process pid
-     * @param timeout Timeout for injection, in milliseconds. Will wait indefinitely if not provided.
-     * @returns new {@link Overlay} object
+     * Create a new overlay surface.
+     * @param luid The GPU LUID for surface textures.
      */
-    static attach(dllDir: string, pid: number, timeout?: number): Promise<Overlay>;
+    static create(luid: GpuLuid): OverlaySurface;
 }
 /**
  * Default dll directory path

package/lib/index.js

@@ -117,31 +117,12 @@ export class Overlay {
         await addon.overlaySetBlockingCursor(this[idSym], id, cursor);
     }
     /**
-     * Update overlay using bitmap buffer. The size of overlay is `width x (data.byteLength / 4 / width)`
-     * @param id target window id
-     * @param width width of the bitmap
-     * @param data bgra formatted bitmap
-     */
-    async updateBitmap(id, width, data) {
-        await addon.overlayUpdateBitmap(this[idSym], id, width, data);
-    }
-    /**
-     * Update overlay using D3D11 shared texture.
-     * @param id target window id
-     * @param width width of the surface
-     * @param height height of the surface
-     * @param handle NT Handle of shared D3D11 Texture
-     * @param rect Area to update
-     */
-    async updateShtex(id, width, height, handle, rect) {
-        await addon.overlayUpdateShtex(this[idSym], id, width, height, handle, rect);
-    }
-    /**
-     * Clear overlay
+     * Update overlay surface.
      * @param id target window id
+     * @param update shared handle update
      */
-    async clearSurface(id) {
-        await addon.overlayClearSurface(this[idSym], id);
+    async updateHandle(id, update) {
+        await addon.overlayUpdateHandle(this[idSym], id, update);
     }
     /**
      * Destroy overlay
@@ -163,6 +144,52 @@ export class Overlay {
         return new Overlay(await addon.attach(dllDir, pid, timeout));
     }
 }
+/**
+ * Represent a surface for overlay.
+ */
+export class OverlaySurface {
+    [idSym];
+    constructor(id) {
+        this[idSym] = id;
+    }
+    /**
+     * Update surface using bitmap buffer. The size of overlay is `width x (data.byteLength / 4 / width)`
+     * @param width width of the bitmap
+     * @param data bgra formatted bitmap
+     */
+    updateBitmap(width, data) {
+        return addon.surfaceUpdateBitmap(this[idSym], width, data);
+    }
+    /**
+     * Update surface using D3D11 shared texture.
+     * @param width width of the surface
+     * @param height height of the surface
+     * @param handle NT Handle of shared D3D11 Texture
+     * @param rect Area to update
+     */
+    updateShtex(width, height, handle, rect) {
+        return addon.surfaceUpdateShtex(this[idSym], width, height, handle, rect);
+    }
+    /**
+     * Clear the surface.
+     */
+    clear() {
+        addon.surfaceClear(this[idSym]);
+    }
+    /**
+     * Destroy the surface.
+     */
+    destroy() {
+        addon.surfaceDestroy(this[idSym]);
+    }
+    /**
+     * Create a new overlay surface.
+     * @param luid The GPU LUID for surface textures.
+     */
+    static create(luid) {
+        return new OverlaySurface(addon.surfaceCreate(luid));
+    }
+}
 /**
  * Default dll directory path
  */

package/lib/types.d.ts

@@ -5,6 +5,30 @@ export type PercentLength = {
     ty: 'percent' | 'length';
     value: number;
 };
+/**
+ * Locally unique identifier for a GPU.
+ */
+export type GpuLuid = {
+    /**
+     * Low part of the LUID.
+     */
+    low: number;
+    /**
+     * High part of the LUID.
+     */
+    high: number;
+};
+/**
+ * Describe a update of overlay surface texture handle.
+ */
+export type UpdateSharedHandle = {
+    /**
+     * KMT handle to surface texture.
+     *
+     * Not supplying this value will clear the existing texture.
+     */
+    handle?: number;
+};
 /**
  * Describe a rectangle when copying from source to destination.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asdf-overlay/core",
-  "version": "0.9.7",
+  "version": "1.0.0",
   "description": "Asdf overlay core Node addon",
   "main": "./lib/index.js",
   "type": "module",