axmol/core/renderer/backend/metal/BufferMTL.mm

/****************************************************************************
 Copyright (c) 2018-2019 Xiamen Yaji Software Co., Ltd.

 https://axmolengine.github.io/

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/

#include "BufferMTL.h"
#include "../Macros.h"
#include "BufferManager.h"

NS_AX_BACKEND_BEGIN

BufferMTL::BufferMTL(id<MTLDevice> mtlDevice, std::size_t size, BufferType type, BufferUsage usage)
    : Buffer(size, type, usage)
{
    if (BufferUsage::DYNAMIC == usage)
    {
        NSMutableArray* mutableDynamicDataBuffers = [NSMutableArray arrayWithCapacity:MAX_INFLIGHT_BUFFER];
        for (int i = 0; i < MAX_INFLIGHT_BUFFER; ++i)
        {
            // Create a new buffer with enough capacity to store one instance of the dynamic buffer data
            id<MTLBuffer> dynamicDataBuffer = [mtlDevice newBufferWithLength:size options:MTLResourceStorageModeShared];
            [mutableDynamicDataBuffers addObject:dynamicDataBuffer];
        }
        _dynamicDataBuffers = [mutableDynamicDataBuffers copy];

        _mtlBuffer = _dynamicDataBuffers[0];
        BufferManager::addBuffer(this);
    }
    else
    {
        _mtlBuffer = [mtlDevice newBufferWithLength:size options:MTLResourceStorageModeShared];
    }
}

BufferMTL::~BufferMTL()
{
    if (BufferUsage::DYNAMIC == _usage)
    {
        for (id<MTLBuffer> buffer in _dynamicDataBuffers)
            [buffer release];

        [_dynamicDataBuffers release];

        BufferManager::removeBuffer(this);
    }
    else
    {
        [_mtlBuffer release];
    }
}

void BufferMTL::updateData(void* data, std::size_t size)
{
    assert(size <= _size);
    updateIndex();
    memcpy((uint8_t*)_mtlBuffer.contents, data, size);
}

void BufferMTL::updateSubData(void* data, std::size_t offset, std::size_t size)
{
    assert(offset + size <= _size);
    updateIndex();
    memcpy((uint8_t*)_mtlBuffer.contents + offset, data, size);
}

id<MTLBuffer> BufferMTL::getMTLBuffer() const
{
    return _mtlBuffer;
}

void BufferMTL::beginFrame()
{
    _indexUpdated = false;
}

void BufferMTL::updateIndex()
{
    if (BufferUsage::DYNAMIC == _usage && !_indexUpdated)
    {
        _currentFrameIndex = (_currentFrameIndex + 1) % MAX_INFLIGHT_BUFFER;
        _mtlBuffer         = _dynamicDataBuffers[_currentFrameIndex];
        _indexUpdated      = true;
    }
}

NS_AX_BACKEND_END