gpu_proc_installer.hpp

Go to the documentation of this file.

// gpu_proc_installer.hpp — who installs Dawn's process-global proc table.
//
// Dawn's C++ wrappers dispatch every call through one process-wide table of
// function pointers that must be installed before the first Dawn object is
// created. GpuSurface and GpuCompute never install it themselves: each calls
// ensure_dawn_procs() first, and that resolves the process's installer exactly
// once.
//
// By default the installer is Pulp's own: it installs Dawn's native procs once
// per process. A build configured with PULP_DAWN_PROCS_HOST_OWNED has no
// default: ensure_dawn_procs() fails until a host registers an installer. An embedding host that owns the table instead (because it
// authenticates the Dawn build, shares the table with other code, or installs
// it itself) registers its installer with set_dawn_proc_installer() before any
// GpuSurface or GpuCompute is created. An installer may install the table, or
// only verify that the host already did and report failure otherwise; Pulp
// treats both the same way and creates no Dawn object until one returns true.
//
// The header names no Dawn type, so it stays usable from code that links the
// GPU device API alone.
#pragma once
 
#if defined(PULP_GPU_RUNTIME)
// This build's device layer is gpu-runtime's (tools/cmake/PulpGpuRuntime.cmake):
// these are its types and functions under their Pulp names, so a Pulp object
// and a gpu-runtime object are one and the same.
#include <gpu_runtime/gpu_proc_installer.hpp>
 
namespace pulp::render {
using gpu_runtime::DawnProcInstaller;
using gpu_runtime::ensure_dawn_procs;
using gpu_runtime::set_dawn_proc_installer;
} // namespace pulp::render
#else // !PULP_GPU_RUNTIME
 
#include <string>
 
namespace pulp::render {

struct DawnProcInstaller {
    bool (*install)(void* context, std::string* error) = nullptr;
    void* context = nullptr;
};

[[nodiscard]] bool set_dawn_proc_installer(const DawnProcInstaller& installer,
                                           std::string* error = nullptr);

[[nodiscard]] bool ensure_dawn_procs(std::string* error = nullptr);
 
} // namespace pulp::render
 
#endif // PULP_GPU_RUNTIME