BufferSuballocator.h

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.
 */
 
#pragma once
 
 
#include "../../GraphicsEngine/interface/RenderDevice.h"
#include "../../GraphicsEngine/interface/DeviceContext.h"
#include "../../GraphicsEngine/interface/Buffer.h"
 
namespace Diligent
{
 
struct IBufferSuballocator;
 
// {562552DA-67F0-40C2-A4AF-F286DFCA1626}
static const INTERFACE_ID IID_BufferSuballocation =
    {0x562552da, 0x67f0, 0x40c2, {0xa4, 0xaf, 0xf2, 0x86, 0xdf, 0xca, 0x16, 0x26}};
 
 
// {71F59B50-7D13-49A7-A4F7-FC986715FFAC}
static const INTERFACE_ID IID_BufferSuballocator =
    {0x71f59b50, 0x7d13, 0x49a7, {0xa4, 0xf7, 0xfc, 0x98, 0x67, 0x15, 0xff, 0xac}};
 
 
struct IBufferSuballocation : public IObject
{
    virtual Uint32 GetOffset() const = 0;
 
    virtual Uint32 GetSize() const = 0;
 
    virtual IBufferSuballocator* GetAllocator() = 0;
 
    virtual void SetUserData(IObject* pUserData) = 0;
 
    virtual IObject* GetUserData() const = 0;
};
 
 
struct IBufferSuballocator : public IObject
{
 
    virtual IBuffer* GetBuffer(IRenderDevice* pDevice, IDeviceContext* pContext) = 0;
 
 
 
    virtual void Allocate(Uint32                 Size,
                          Uint32                 Alignment,
                          IBufferSuballocation** ppSuballocation) = 0;
 
 
 
    virtual Uint32 GetFreeSize() = 0;
 
 
    virtual Uint32 GetVersion() const = 0;
};
 
struct BufferSuballocatorCreateInfo
{
    BufferDesc Desc;
 
 
 
    Uint32 ExpansionSize = 0;
 
 
 
    Uint32 SuballocationObjAllocationGranularity = 64;
};
 
 
void CreateBufferSuballocator(IRenderDevice*                      pDevice,
                              const BufferSuballocatorCreateInfo& CreateInfo,
                              IBufferSuballocator**               ppBufferSuballocator);
 
} // namespace Diligent