stratum-rs-overlay 3.0.1 → 4.1.0-beta.0

package/README.md

@@ -93,13 +93,14 @@ app.whenReady().then(() => {
       // eventType: focus | move | blur
       // x, y, width, height, targetName
       console.log('[STRATUM-RS]', event);
-    },
-    {
-      cursorPollIntervalMs: 100,
-      cursorEmitIntervalMs: 100,
-      idlePollIntervalMs: 100,
     }
   );
+
+  stratumOverlay.startMouseTracking(undefined, {
+    cursorPollIntervalMs: 100,
+    cursorEmitIntervalMs: 100,
+    idlePollIntervalMs: 100,
+  });
 });
 ```
 
@@ -107,7 +108,9 @@ app.whenReady().then(() => {
 - `init(licenseKeyHex: string): boolean`
 - `setOverlayPid(pid: number): void`
 - `setOverlayHwnd(hwnd: number): void`
-- `startTracking(targets, callback, options): void`
+- `startTracking(targets, callback): void`
+- `startMouseTracking(targetName?, options?): boolean`
+- `stopMouseTracking(): boolean`
 - `focusLastTarget(): boolean`
 - `stopTracking(): boolean`
 

package/dist/index.d.ts

@@ -12,18 +12,39 @@ export interface TargetConfig {
   mode: Mode
 }
 export interface OverlayEvent {
+  /** "focus" | "move" | "blur" | "cursor" | "cursor-leave" | "error" */
   eventType: string
+  /** 매칭된 대상 이름. "error" 이벤트에서는 실패 사유 */
   targetName: string
+  /** DWMWA_EXTENDED_FRAME_BOUNDS 기준 창 좌표 (타이틀바/테두리 포함). cursor 이벤트에서는 창 기준 커서 좌표 */
   x: number
   y: number
   width: number
   height: number
+  /** 대상 창의 프로세스 ID (focus/move/cursor, 그 외 0) */
+  pid: number
+  /** 대상 창 핸들 (focus/move/cursor, 그 외 0) */
+  hwnd: number
+  /**
+   * 클라이언트 영역 화면 좌표 (GetClientRect + ClientToScreen, 타이틀바/테두리 제외).
+   * cursor 이벤트에서는 클라이언트 영역 기준 커서 좌표 (clientWidth/clientHeight = 0)
+   */
+  clientX: number
+  clientY: number
+  clientWidth: number
+  clientHeight: number
+  /** focus 이벤트에만 존재. SHQueryUserNotificationState == QUNS_RUNNING_D3D_FULL_SCREEN */
+  fullscreenExclusive?: boolean
 }
-export interface TrackingOptions {
+export interface MouseTrackingOptions {
   cursorPollIntervalMs?: number
   cursorEmitIntervalMs?: number
   idlePollIntervalMs?: number
 }
+export interface TrackingOptions {
+  /** 대상 창이 포그라운드를 잃은 뒤 blur 를 보내기 전 유예 시간(ms). 기본 0 = 즉시 blur */
+  blurGraceMs?: number
+}
 /**
  * License Key Verification
  * @param License Key
@@ -35,13 +56,13 @@ export declare function setOverlayHwnd(hwnd: number): void
 export declare function focusLastTarget(): boolean
 export declare function areKeysPressed(vkCodes: Array<number>): boolean
 export declare function stopMouseTracking(): boolean
-export declare function startMouseTracking(targetName?: string | undefined | null): boolean
+export declare function startMouseTracking(targetName?: string | undefined | null, options?: MouseTrackingOptions | undefined | null): boolean
 export declare function stopTracking(): boolean
 /**
  * Start Tracking
  * @param targets: Vec<TargetConfig>
  * @param callback: ThreadsafeFunction<OverlayEvent, ErrorStrategy::CalleeHandled>
- * @param options: TrackingOptions (optional)
- * @return Result<()>
+ * @param options: TrackingOptions (optional, blurGraceMs)
+ * @return Result<()> - 훅 등록 실패 시 Err
 */
 export declare function startTracking(targets: Array<TargetConfig>, callback: (err: Error | null, event?: OverlayEvent) => void, options?: TrackingOptions | undefined | null): void

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stratum-rs-overlay",
-  "version": "3.0.1",
+  "version": "4.1.0-beta.0",
   "description": "A high-performance, non-intrusive game overlay library for Electron powered by Rust.",
   "os": [
     "win32"