@overwolf/ow-electron-packages-types 1.1.13-beta.1 → 1.1.13

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@overwolf/ow-electron-packages-types",
-    "version": "1.1.13-beta.1",
+    "version": "1.1.13",
     "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
     "license": "MIT",
     "types": "types.d.ts",

package/types.d.ts

@@ -5576,7 +5576,9 @@ type GpuPreference = "default" | "highPerformance";
  *   game.
  * - `gpuAdapterMismatch`—The game renders on a different GPU adapter than Chromium,
  *   and a shared texture handle can only be opened on the adapter that created it. Fixable
- *   with {@link IOverwolfOverlayApi.setGpuPreference} and an application restart.
+ *   with {@link IOverwolfOverlayApi.setGpuPreference} and an application restart, or from
+ *   the first launch with Chromium's `force_high_performance_gpu` switch (see
+ *   {@link IOverwolfOverlayApi.setGpuPreference}).
  * - `copyFailure`—The game repeatedly failed to open the shared texture handles it
  *   received in-game. The overlay retried, then fell back to the CPU copy path.
  *   {@link IOverwolfOverlayApi.setGpuPreference} may help when the root cause is
@@ -6609,6 +6611,13 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * the application is *already* aligned and therefore needs no restart; this method is
    * idempotent, so calling it unconditionally is safe.
    *
+   * **Alternative with no restart.** Appending Chromium's `force_high_performance_gpu` switch
+   * from the application's main script, **before** the `ready` event, starts the GPU process
+   * on the high-performance adapter from the first launch. It affects only Chromium's GPU
+   * process and writes no Windows setting, though it still keeps the discrete GPU awake while
+   * the application runs. The overlay package loads after `ready`, so it cannot apply the
+   * switch itself.
+   *
    * **Side effects — read before calling.** It moves the **entire application's**
    * rendering to that GPU, draining laptop battery and keeping the discrete GPU awake; it is
    * persistent, user-visible Windows state under
@@ -6623,6 +6632,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * @throws If the registry cannot be written, or on a non-Windows platform.
    * @see {@link GpuPreference}.
    * @see {@link https://dev.overwolf.com/ow-electron/reference/examples/overlay | Overlay examples}
+   * @see {@link https://www.electronjs.org/docs/latest/api/command-line-switches#--force_high_performance_gpu | --force_high_performance_gpu}
    *
    * @example
    * ```ts
@@ -6634,6 +6644,12 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * });
    * ```
    *
+   * @example
+   * ```ts
+   * // Main script, before `app` is ready - no restart needed.
+   * app.commandLine.appendSwitch('force_high_performance_gpu');
+   * ```
+   *
    * @since 2.0.5
    */
   setGpuPreference(preference: GpuPreference): Promise<void>;
@@ -6806,8 +6822,9 @@ interface IOverwolfOverlayApi extends EventEmitter {
    *   (D3D9 / OpenGL / Vulkan). Nothing to fix.
    * - `gpuAdapterMismatch`&mdash;the game renders on a **different GPU adapter than
    *   Chromium**; a shared texture handle can only be opened on the adapter that created it.
-   *   Fixable with {@link IOverwolfOverlayApi.setGpuPreference} and a restart; both adapters
-   *   are named in the overlay log.
+   *   Fixable with {@link IOverwolfOverlayApi.setGpuPreference} and a restart, or from the
+   *   first launch with Chromium's `force_high_performance_gpu` switch; both adapters are
+   *   named in the overlay log.
    * - `copyFailure`&mdash;the game **repeatedly failed to open the shared texture handles it
    *   received in-game**. The overlay retried, then abandoned the path for this game.
    *   {@link IOverwolfOverlayApi.setGpuPreference} may help when the root cause is