DynamicTextureAtlas.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/Texture.h"
#include "../../../Common/interface/BasicMath.hpp"
 
namespace Diligent
{
 
struct IDynamicTextureAtlas;
 
// {F7ACDCFB-074F-4E31-94C5-DD4C988E4532}
static const INTERFACE_ID IID_TextureAtlasSuballocation =
    {0xf7acdcfb, 0x74f, 0x4e31, {0x94, 0xc5, 0xdd, 0x4c, 0x98, 0x8e, 0x45, 0x32}};
 
 
// {00E1D6FA-47B4-4062-B96C-D3E191A02351}
static const INTERFACE_ID IID_DynamicTextureAtlas =
    {0xe1d6fa, 0x47b4, 0x4062, {0xb9, 0x6c, 0xd3, 0xe1, 0x91, 0xa0, 0x23, 0x51}};
 
 
struct ITextureAtlasSuballocation : public IObject
{
    virtual uint2 GetOrigin() const = 0;
 
    virtual Uint32 GetSlice() const = 0;
 
    virtual uint2 GetSize() const = 0;
 
    virtual float4 GetUVScaleBias() const = 0;
 
    virtual IDynamicTextureAtlas* GetAtlas() = 0;
 
    virtual void SetUserData(IObject* pUserData) = 0;
 
    virtual IObject* GetUserData() const = 0;
};
 
struct IDynamicTextureAtlas : public IObject
{
 
    virtual ITexture* GetTexture(IRenderDevice* pDevice, IDeviceContext* pContext) = 0;
 
 
 
    virtual void Allocate(Uint32                       Width,
                          Uint32                       Height,
                          ITextureAtlasSuballocation** ppSuballocation) = 0;
 
 
    virtual const TextureDesc& GetAtlasDesc() const = 0;
 
    virtual Uint32 GetVersion() const = 0;
};
 
 
struct DynamicTextureAtlasCreateInfo
{
 
    TextureDesc Desc;
 
 
 
    Uint32 TextureGranularity = 128;
 
 
    Uint32 ExtraSliceCount = 0;
 
 
    Uint32 MaxSliceCount = 2048;
 
 
 
    Uint32 SuballocationObjAllocationGranularity = 64;
};
 
 
void CreateDynamicTextureAtlas(IRenderDevice*                       pDevice,
                               const DynamicTextureAtlasCreateInfo& CreateInfo,
                               IDynamicTextureAtlas**               ppAtlas);
 
} // namespace Diligent