ComputeBuffer.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 ComputeBuffer;
using ComputeBufferResult = Result<Ref<ComputeBuffer>>;
 
class JPH_EXPORT ComputeBuffer : public RefTarget<ComputeBuffer>, public NonCopyable
{
public:
    JPH_OVERRIDE_NEW_DELETE
 
    enum class EType
    {
        UploadBuffer,           
        ReadbackBuffer,         
        ConstantBuffer,         
        Buffer,                 
        RWBuffer,               
    };
 
                                ComputeBuffer(EType inType, uint64 inSize, uint inStride) : mType(inType), mSize(inSize), mStride(inStride) { }
    virtual                     ~ComputeBuffer()                                { JPH_ASSERT(!mIsMapped); }
 
    EType                       GetType() const                                 { return mType; }
    uint64                      GetSize() const                                 { return mSize; }
    uint                        GetStride() const                               { return mStride; }
 
    enum class EMode
    {
        Read,                   
        Write,                  
    };
 
    void *                      Map(EMode inMode)                               { JPH_ASSERT(!mIsMapped); JPH_IF_ENABLE_ASSERTS(mIsMapped = true;) return MapInternal(inMode); }
    template <typename T> T *   Map(EMode inMode)                               { JPH_ASSERT(!mIsMapped); JPH_IF_ENABLE_ASSERTS(mIsMapped = true;) JPH_ASSERT(sizeof(T) == mStride); return reinterpret_cast<T *>(MapInternal(inMode)); }
    void                        Unmap()                                         { JPH_ASSERT(mIsMapped); JPH_IF_ENABLE_ASSERTS(mIsMapped = false;) UnmapInternal(); }
 
    virtual ComputeBufferResult CreateReadBackBuffer() const = 0;
 
protected:
    EType                       mType;
    uint64                      mSize;
    uint                        mStride;
#ifdef JPH_ENABLE_ASSERTS
    bool                        mIsMapped = false;
#endif // JPH_ENABLE_ASSERTS
 
    virtual void *              MapInternal(EMode inMode) = 0;
    virtual void                UnmapInternal() = 0;
};
 
JPH_NAMESPACE_END