dawn-cmake/src/dawn/utils/GLFWUtils.h

// Copyright 2020 The Dawn Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SRC_DAWN_UTILS_GLFWUTILS_H_
#define SRC_DAWN_UTILS_GLFWUTILS_H_

#include <memory>

#include "dawn/webgpu_cpp.h"

struct GLFWwindow;

namespace utils {

    // Adds all the necessary glfwWindowHint calls for the next GLFWwindow created to be used with
    // the specified backend.
    void SetupGLFWWindowHintsForBackend(wgpu::BackendType type);

    // Does the necessary setup on the GLFWwindow to allow creating a wgpu::Surface with it and
    // calls `instance.CreateSurface` with the correct descriptor for this window.
    // Returns a null wgpu::Surface on failure.
    wgpu::Surface CreateSurfaceForWindow(const wgpu::Instance& instance, GLFWwindow* window);

    // Use for testing only. Does everything that CreateSurfaceForWindow does except the call to
    // CreateSurface. Useful to be able to modify the descriptor for testing, or when trying to
    // avoid using the global proc table.
    std::unique_ptr<wgpu::ChainedStruct> SetupWindowAndGetSurfaceDescriptor(GLFWwindow* window);

}  // namespace utils

#endif  // SRC_DAWN_UTILS_GLFWUTILS_H_