ComputeSystem.h

Go to the documentation of this file.

// 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
 
class JPH_EXPORT ComputeSystem : public RefTarget<ComputeSystem>, public NonCopyable
{
public:
    JPH_DECLARE_RTTI_ABSTRACT_BASE(JPH_EXPORT, ComputeSystem)
 
    
    virtual                             ~ComputeSystem() = default;
 
    virtual ComputeShaderResult         CreateComputeShader(const char *inName, uint32 inGroupSizeX, uint32 inGroupSizeY = 1, uint32 inGroupSizeZ = 1) = 0;
 
    virtual ComputeBufferResult         CreateComputeBuffer(ComputeBuffer::EType inType, uint64 inSize, uint inStride, const void *inData = nullptr) = 0;
 
    virtual ComputeQueueResult          CreateComputeQueue() = 0;
 
    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
extern JPH_EXPORT ComputeSystemResult   CreateComputeSystemVK();
#endif
 
#ifdef JPH_USE_CPU_COMPUTE
extern JPH_EXPORT ComputeSystemResult   CreateComputeSystemCPU();
#endif
 
#ifdef JPH_USE_DX12
 
extern JPH_EXPORT ComputeSystemResult   CreateComputeSystemDX12();
 
inline ComputeSystemResult              CreateComputeSystem()       { return CreateComputeSystemDX12(); }
 
#elif defined(JPH_USE_MTL)
 
extern JPH_EXPORT ComputeSystemResult   CreateComputeSystemMTL();
 
inline ComputeSystemResult              CreateComputeSystem()       { return CreateComputeSystemMTL(); }
 
#elif defined(JPH_USE_VK)
 
inline ComputeSystemResult              CreateComputeSystem()       { return CreateComputeSystemVK(); }
 
#else
 
inline ComputeSystemResult              CreateComputeSystem()       { ComputeSystemResult result; result.SetError("Not implemented"); return result; }
 
#endif
 
JPH_NAMESPACE_END