feat: rename createWindowSurface to windowSurface

deno-windowing · Jan 24, 2024 · 1a2b4ec · 1a2b4ec
1 parent d8f36ec
commit 1a2b4ec
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 18 deletions.
diff --git a/examples/webgpu.ts b/examples/webgpu.ts
@@ -12,7 +12,7 @@ const window = createWindow({
 
 const { width, height } = window.framebufferSize;
 
-const surface = window.createWindowSurface();
+const surface = window.windowSurface();
 
 const context = surface.getContext("webgpu");
 

diff --git a/src/core/window.ts b/src/core/window.ts
@@ -314,26 +314,14 @@ export abstract class DwmWindow {
     image: ImageStruct,
   ): void;
 
-  /**
-   * Retrieves the window and display/instance handles required for WebGPU
-   * ```ts
-   * const [window, display, instance] = win.rawHandle();
-   * ```
-   */
-  abstract rawHandle(): [
-    RawPlatform,
-    Deno.UnsafePointerView,
-    Deno.UnsafePointerView | null,
-  ];
-
   /**
    * Creates a Window Surface for Use with WebGPU
    * ```ts
-   * const surface = win.createWindowSurface();
+   * const surface = win.windowSurface();
    * const context = surface.getContext("webgpu");
    * ```
    */
-  abstract createWindowSurface(): Deno.UnsafeWindowSurface;
+  abstract windowSurface(): Deno.UnsafeWindowSurface;
   /**
    * Check if the window is closed
    */

diff --git a/src/platform/glfw/window.ts b/src/platform/glfw/window.ts
@@ -1069,7 +1069,7 @@ export class WindowGlfw extends DwmWindow {
     glfwSetCursorPos(this.#nativeHandle, x, y);
   }
 
-  rawHandle(): [
+  #rawHandle(): [
     RawPlatform,
     Deno.UnsafePointerView,
     Deno.UnsafePointerView | null,
@@ -1119,8 +1119,8 @@ export class WindowGlfw extends DwmWindow {
     ];
   }
 
-  createWindowSurface() {
-    const [platform, handle, display] = this.rawHandle();
+  windowSurface() {
+    const [platform, handle, display] = this.#rawHandle();
     return new Deno.UnsafeWindowSurface(platform, handle, display);
   }