metalBuffer.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2025-2026 Arnis Lektauers
//
// Created by Arnis Lektauers on 19.07.2025.
//
#pragma once
 
#include <Metal/Metal.hpp>
 
#include "metalGraphicsDevice.h"
#include "platform/graphics/gpu.h"
 
namespace visutwin::canvas::gpu
{
    enum BufferUsage : uint32_t {
        MAP_READ = 0x0001,
        MAP_WRITE = 0x0002,
        COPY_SRC = 0x0004,
        COPY_DST = 0x0008,
        INDEX = 0x0010,
        VERTEX = 0x0020,
        UNIFORM = 0x0040,
        STORAGE = 0x0080,
        INDIRECT = 0x0100,
        QUERY_RESOLVE = 0x0200
    };

    class MetalBuffer : public HardwareBuffer {
    public:
        explicit MetalBuffer(const BufferUsage usageFlags) : _usageFlags(usageFlags) {}
        ~MetalBuffer() override;
 
        void allocate(MTL::Device* device, size_t size);

        void write(size_t bufferOffset, const void* data, size_t dataSize) const;
 
        [[nodiscard]] size_t size() const {
            return _buffer ? _buffer->length() : 0;
        }
 
        [[nodiscard]] MTL::Buffer* raw() const {
            return _buffer;
        }
 
        // HardwareBuffer interface
        void upload(GraphicsDevice* device, const void* data, size_t size) override;
        void* nativeHandle() const override { return _buffer; }
 
        // Unlock the buffer and upload data to GPU
        void unlock(MetalGraphicsDevice* device, const std::vector<uint8_t>& storage);
 
        // Allocate the buffer with the specified size
        void allocate(MetalGraphicsDevice* device, size_t size);

        void adoptBuffer(MTL::Buffer* buffer);
 
    private:
        BufferUsage _usageFlags;
        MTL::Buffer* _buffer = nullptr;
    };
}