Texture.h

/*     Copyright 2015-2018 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
 * 
 *  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 OF ANY PROPRIETARY RIGHTS.
 *
 *  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 "DeviceObject.h"

namespace Diligent
{

// {A64B0E60-1B5E-4CFD-B880-663A1ADCBE98}
static constexpr INTERFACE_ID IID_Texture =
{ 0xa64b0e60, 0x1b5e, 0x4cfd, { 0xb8, 0x80, 0x66, 0x3a, 0x1a, 0xdc, 0xbe, 0x98 } };

struct DepthStencilClearValue
{
    Float32 Depth;
    Uint8 Stencil;
    DepthStencilClearValue() : 
        Depth(1.f),
        Stencil(0)
    {}
};

struct OptimizedClearValue
{
    TEXTURE_FORMAT Format;
    Float32 Color[ 4 ];
    DepthStencilClearValue DepthStencil;
    OptimizedClearValue() : 
        Format(TEX_FORMAT_UNKNOWN)
    {
        Color[0] = 0;
        Color[1] = 0;
        Color[2] = 0;
        Color[3] = 0;
    }

    bool operator == (const OptimizedClearValue& rhs)const
    {
        return Format == rhs.Format &&
               Color[0] == rhs.Color[0] &&
               Color[1] == rhs.Color[1] &&
               Color[2] == rhs.Color[2] &&
               Color[3] == rhs.Color[3] &&
               DepthStencil.Depth   == rhs.DepthStencil.Depth &&
               DepthStencil.Stencil == rhs.DepthStencil.Stencil;
    }
};

struct TextureDesc : DeviceObjectAttribs
{
    RESOURCE_DIMENSION Type;

    Uint32 Width;

    Uint32 Height;
    union
    {
        Uint32 ArraySize;

        Uint32 Depth;
    };

    TEXTURE_FORMAT Format;

    Uint32 MipLevels;

    Uint32 SampleCount;

    USAGE Usage;

    Uint32 BindFlags;

    Uint32 CPUAccessFlags;
    

    Uint32 MiscFlags;
    
    OptimizedClearValue ClearValue;


    TextureDesc() : 
        Type(RESOURCE_DIM_UNDEFINED),
        Width(0),
        Height(0),
        ArraySize(1),
        Format(TEX_FORMAT_UNKNOWN),
        MipLevels(1),
        SampleCount(1),
        Usage(USAGE_DEFAULT),
        BindFlags(0),
        CPUAccessFlags(0),
        MiscFlags(0)
    {
    }


    bool operator ==(const TextureDesc& RHS)const
    {
                // Name is primarily used for debug purposes and does not affect the state.
                // It is ignored in comparison operation.
        return  // strcmp(Name, RHS.Name) == 0          &&
                Type           == RHS.Type           &&
                Width          == RHS.Width          &&
                Height         == RHS.Height         &&
                ArraySize      == RHS.ArraySize      &&
                Format         == RHS.Format         &&
                MipLevels      == RHS.MipLevels      &&
                SampleCount    == RHS.SampleCount    &&
                Usage          == RHS.Usage          &&
                BindFlags      == RHS.BindFlags      &&
                CPUAccessFlags == RHS.CPUAccessFlags &&
                MiscFlags      == RHS.MiscFlags      &&
                ClearValue     == RHS.ClearValue;
    }
};

struct TextureSubResData
{
    const void* pData;

    class IBuffer *pSrcBuffer;

    Uint32 Stride;

    Uint32 DepthStride;


    TextureSubResData():
        pData(nullptr),
        pSrcBuffer(nullptr),
        Stride(0),
        DepthStride(0)
    {}
    
    TextureSubResData(void *_pData, Uint32 _Stride, Uint32 _DepthStride=0) :
        pData(_pData),
        pSrcBuffer(nullptr),
        Stride(_Stride),
        DepthStride(_DepthStride)
    {}

    TextureSubResData(IBuffer *_pBuffer, Uint32 _Stride, Uint32 _DepthStride=0) :
        pData(nullptr),
        pSrcBuffer(_pBuffer),
        Stride(_Stride),
        DepthStride(_DepthStride)
    {}
};

struct TextureData
{
    TextureSubResData *pSubResources;

    Uint32 NumSubresources;


    TextureData() : 
        pSubResources(nullptr),
        NumSubresources(0)
    {}
};

struct MappedTextureSubresource
{
    PVoid pData = nullptr;
    Uint32 Stride = 0;
    Uint32 DepthStride = 0;
};

class ITexture : public IDeviceObject
{
public:
    virtual void QueryInterface( const Diligent::INTERFACE_ID &IID, IObject **ppInterface ) = 0;

    virtual const TextureDesc& GetDesc()const = 0;
    

    virtual void CreateView(const struct TextureViewDesc &ViewDesc, class ITextureView **ppView) = 0;

    
    virtual ITextureView* GetDefaultView( TEXTURE_VIEW_TYPE ViewType ) = 0;


    virtual void UpdateData( class IDeviceContext *pContext, Uint32 MipLevel, Uint32 Slice, const Box &DstBox, const TextureSubResData &SubresData ) = 0;


    virtual void CopyData(IDeviceContext *pContext, 
                          ITexture *pSrcTexture, 
                          Uint32 SrcMipLevel,
                          Uint32 SrcSlice,
                          const Box *pSrcBox,
                          Uint32 DstMipLevel,
                          Uint32 DstSlice,
                          Uint32 DstX,
                          Uint32 DstY,
                          Uint32 DstZ) = 0;

    virtual void Map( IDeviceContext *pContext, Uint32 Subresource, MAP_TYPE MapType, Uint32 MapFlags, MappedTextureSubresource &MappedData ) = 0;
    virtual void Unmap( IDeviceContext *pContext, Uint32 Subresource, MAP_TYPE MapType, Uint32 MapFlags ) = 0;


    virtual void* GetNativeHandle() = 0;
};

}