JoltPhysics/Jolt/Compute/ComputeSystem.h

// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
// SPDX-FileCopyrightText: 2025 Jorrit Rouwe
// SPDX-License-Identifier: MIT

#pragma once

#include <Jolt/Compute/ComputeShader.h>
#include <Jolt/Compute/ComputeBuffer.h>
#include <Jolt/Compute/ComputeQueue.h>
#include <Jolt/Core/RTTI.h>

JPH_NAMESPACE_BEGIN

/// Interface to run a workload on the GPU
class JPH_EXPORT ComputeSystem : public RefTarget<ComputeSystem>, public NonCopyable
{
public:
	JPH_DECLARE_RTTI_ABSTRACT_BASE(JPH_EXPORT, ComputeSystem)

	/// Destructor
	virtual								~ComputeSystem() = default;

	/// Compile a compute shader
	virtual ComputeShaderResult			CreateComputeShader(const char *inName, uint32 inGroupSizeX, uint32 inGroupSizeY = 1, uint32 inGroupSizeZ = 1) = 0;

	/// Create a buffer for use with a compute shader
	virtual ComputeBufferResult			CreateComputeBuffer(ComputeBuffer::EType inType, uint64 inSize, uint inStride, const void *inData = nullptr) = 0;

	/// Create a queue for executing compute shaders
	virtual ComputeQueueResult			CreateComputeQueue() = 0;

	/// Callback used when loading shaders
	using ShaderLoader = std::function<bool(const char *inName, Array<uint8> &outData, String &outError)>;
	ShaderLoader						mShaderLoader = [](const char *, Array<uint8> &, String &outError) { JPH_ASSERT(false, "Override this function"); outError = "Not implemented"; return false; };
};

using ComputeSystemResult = Result<Ref<ComputeSystem>>;

#ifdef JPH_USE_VK
/// Factory function to create a compute system using Vulkan
extern JPH_EXPORT ComputeSystemResult	CreateComputeSystemVK();
#endif

#ifdef JPH_USE_CPU_COMPUTE
/// Factory function to create a compute system that falls back to CPU.
/// This is intended mainly for debugging purposes and is not optimized for performance
extern JPH_EXPORT ComputeSystemResult	CreateComputeSystemCPU();
#endif

#ifdef JPH_USE_DX12

/// Factory function to create a compute system using DirectX 12
extern JPH_EXPORT ComputeSystemResult	CreateComputeSystemDX12();

/// Factory function to create the default compute system for this platform
inline ComputeSystemResult 				CreateComputeSystem()		{ return CreateComputeSystemDX12(); }

#elif defined(JPH_USE_MTL)

/// Factory function to create a compute system using Metal
extern JPH_EXPORT ComputeSystemResult	CreateComputeSystemMTL();

/// Factory function to create the default compute system for this platform
inline ComputeSystemResult 				CreateComputeSystem()		{ return CreateComputeSystemMTL(); }

#elif defined(JPH_USE_VK)

/// Factory function to create the default compute system for this platform
inline ComputeSystemResult 				CreateComputeSystem()		{ return CreateComputeSystemVK(); }

#else

/// Fallback implementation when no compute system is available
inline ComputeSystemResult 				CreateComputeSystem()		{ ComputeSystemResult result; result.SetError("Not implemented"); return result; }

#endif

JPH_NAMESPACE_END