echomap::SurfaceFactory Class Reference

Provides static helpers to create and bind a WebGPU Surface to a GLFW window across Wasm and non-Wasm platforms. More...

#include <SurfaceFactory.hpp>

Static Public Member Functions
static wgpu::Surface	create_surface (const wgpu::Instance &instance, GLFWwindow *window)
	Creates and binds a Surface to the given GLFW window.

Static Private Member Functions
static std::unique_ptr< wgpu::ChainedStruct >	get_surface_descriptor (GLFWwindow *window)
	Produce an owning container of the WebGPU Surface descriptor for the given GLFW window.

Detailed Description

Provides static helpers to create and bind a WebGPU Surface to a GLFW window across Wasm and non-Wasm platforms.

Definition at line 21 of file SurfaceFactory.hpp.

Member Function Documentation

create_surface()

wgpu::Surface echomap::SurfaceFactory::create_surface ( const wgpu::Instance & instance, GLFWwindow * window )

static

Creates and binds a Surface to the given GLFW window.

Parameters

instance	The WebGPU Instance in which the Surface should be created.
window	The GLFW window pointer to the target window.

Returns

A Surface registered to the Instance and bound to the GLFWwindow.

Exceptions

std::runtime_error

A Surface could not be created and bound for the given Window.

Definition at line 70 of file SurfaceFactory.cpp.

{
    const auto chainedDescriptor = get_surface_descriptor(window);
    if (chainedDescriptor == nullptr)
        throw std::runtime_error("Could not create and bind a Surface to the given window.");
 
    wgpu::SurfaceDescriptor descriptor;
    descriptor.nextInChain = chainedDescriptor.get();
 
    return instance.CreateSurface(&descriptor);
}

get_surface_descriptor()

std::unique_ptr< wgpu::ChainedStruct > echomap::SurfaceFactory::get_surface_descriptor ( GLFWwindow * window )

staticprivate

Produce an owning container of the WebGPU Surface descriptor for the given GLFW window.

Supported platforms:

• Emscripten
• Wayland
• X11
• Win32
• Cocoa/Apple

Parameters

window

The GLFW window to bind to the WebGPU surface.

Returns

An owning container detaining the chain. The next chained element is the bound Surface. If a suitable Surface could not be bound, nullptr is returned.

Definition at line 85 of file SurfaceFactory.cpp.

{
    // Verify that the window is valid in the runtime.
    if (glfwGetWindowAttrib(window, GLFW_CLIENT_API) != GLFW_NO_API)
        return nullptr;
 
#if defined(__EMSCRIPTEN__)
    auto desc = std::make_unique<wgpu::EmscriptenSurfaceSourceCanvasHTMLSelector>();
    desc->selector = "#canvas";
    return desc;
#else
    // Use the GLFW_EXPOSE_NATIVE_* flags to determine which GLFW platforms we can handle.
 
    // ReSharper disable once CppDefaultCaseNotHandledInSwitchStatement
    switch (glfwGetPlatform()) {
#if defined(GLFW_EXPOSE_NATIVE_WAYLAND)
    case GLFW_PLATFORM_WAYLAND: {
        auto desc = std::make_unique<wgpu::SurfaceSourceWaylandSurface>();
        desc->display = glfwGetWaylandDisplay();
        desc->surface = glfwGetWaylandWindow(window);
        return desc;
    }
#endif
#if defined(GLFW_EXPOSE_NATIVE_X11)
    case GLFW_PLATFORM_X11: {
        auto desc = std::make_unique<wgpu::SurfaceSourceXlibWindow>();
        desc->display = glfwGetX11Display();
        desc->window = glfwGetX11Window(window);
        return desc;
    }
#endif
#if defined(GLFW_EXPOSE_NATIVE_WIN32)
    case GLFW_PLATFORM_WIN32: {
        auto desc = std::make_unique<wgpu::SurfaceSourceWindowsHWND>();
        desc->hwnd = glfwGetWin32Window(window);
        desc->hinstance = GetModuleHandle(nullptr);
        return desc;
    }
#endif
#if defined(GLFW_EXPOSE_NATIVE_COCOA)
    case GLFW_PLATFORM_COCOA: {
        /*
         * On Apple platforms, more work is required to configure the Metal layer on the Cocoa Surface through the
         * Objective-C messaging APIs.
         */
        auto ns_window = glfwGetCocoaWindow(window);
        CFRetain(ns_window);
 
        auto view = objc_call<id>(ns_window, "contentView");
        CFRetain(view);
 
        objc_call<void, BOOL>(view, "setWantsLayer:", YES);
        auto layer = objc_call<id>("CAMetalLayer", "layer");
        auto scale_factor = objc_call<CGFloat>(ns_window, "backingScaleFactor");
        objc_call<void, CGFloat>(layer, "setContentsScale:", scale_factor);
        objc_call<void, id>(view, "setLayer:", layer);
 
        auto desc = std::make_unique<wgpu::SurfaceSourceMetalLayer>();
        desc->layer = layer;
        CFRelease(view);
        CFRelease(ns_window);
 
        return desc;
    }
#endif
    }
#endif
 
    // No handlers were enabled. This should be caught be a compile-time check.
    // ReSharper disable once CppDFAUnreachableCode
    return nullptr;
}

---

The documentation for this class was generated from the following files:

• src/platform/SurfaceFactory.hpp
• src/platform/SurfaceFactory.cpp