SRBMemoryAllocator.hpp

Go to the documentation of this file.

/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */
 
// Helper class that handles memory allocation for shader resource binding objects
 
#pragma once
 
#include "../../../Common/interface/FixedBlockMemoryAllocator.hpp"
 
namespace Diligent
{
 
class SRBMemoryAllocator
{
public:
    SRBMemoryAllocator(IMemoryAllocator& RawMemAllocator) :
        m_RawMemAllocator(RawMemAllocator)
    {}
 
    ~SRBMemoryAllocator();
 
    void Initialize(Uint32              SRBAllocationGranularity,
                    Uint32              ShaderVariableDataAllocatorCount,
                    const size_t* const ShaderVariableDataSizes,
                    Uint32              ResourceCacheDataAllocatorCount,
                    const size_t* const ResourceCacheDataSizes);
 
    IMemoryAllocator& GetShaderVariableDataAllocator(Uint32 Ind)
    {
        VERIFY_EXPR(m_DataAllocators == nullptr || Ind < m_ShaderVariableDataAllocatorCount);
        return m_DataAllocators != nullptr ? m_DataAllocators[Ind] : m_RawMemAllocator;
    }
 
    IMemoryAllocator& GetResourceCacheDataAllocator(Uint32 Ind)
    {
        VERIFY_EXPR(m_DataAllocators == nullptr || Ind < m_ResourceCacheDataAllocatorCount);
        return m_DataAllocators != nullptr ? m_DataAllocators[m_ShaderVariableDataAllocatorCount + Ind] : m_RawMemAllocator;
    }
 
private:
    IMemoryAllocator& m_RawMemAllocator;
 
    // Fixed-block allocators for every shader stage
    FixedBlockMemoryAllocator* m_DataAllocators = nullptr;
 
    Uint32 m_ShaderVariableDataAllocatorCount = 0;
    Uint32 m_ResourceCacheDataAllocatorCount  = 0;
};
 
} // namespace Diligent