ComputeQueue.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/Core/Reference.h>
#include <Jolt/Core/NonCopyable.h>
#include <Jolt/Core/Result.h>
 
JPH_NAMESPACE_BEGIN
 
class ComputeShader;
class ComputeBuffer;
 
class JPH_EXPORT ComputeQueue : public RefTarget<ComputeQueue>, public NonCopyable
{
public:
    JPH_OVERRIDE_NEW_DELETE
 
    virtual                 ~ComputeQueue() = default;
 
    virtual void            SetShader(const ComputeShader *inShader) = 0;
 
    enum class EBarrier
    {
        Yes,
        No
    };
 
    virtual void            SetConstantBuffer(const char *inName, const ComputeBuffer *inBuffer) = 0;
 
    virtual void            SetBuffer(const char *inName, const ComputeBuffer *inBuffer) = 0;
 
    virtual void            SetRWBuffer(const char *inName, ComputeBuffer *inBuffer, EBarrier inBarrier = EBarrier::Yes) = 0;
 
    virtual void            Dispatch(uint inThreadGroupsX, uint inThreadGroupsY = 1, uint inThreadGroupsZ = 1) = 0;
 
    virtual void            ScheduleReadback(ComputeBuffer *inDst, const ComputeBuffer *inSrc) = 0;
 
    virtual void            Execute() = 0;
 
    virtual void            Wait() = 0;
 
    void                    ExecuteAndWait()
    {
        Execute();
        Wait();
    }
};
 
using ComputeQueueResult = Result<Ref<ComputeQueue>>;
 
JPH_NAMESPACE_END