TextureView.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
{

// {5B2EA04E-8128-45E4-AA4D-6DC7E70DC424}
static constexpr INTERFACE_ID IID_TextureView =
{ 0x5b2ea04e, 0x8128, 0x45e4, { 0xaa, 0x4d, 0x6d, 0xc7, 0xe7, 0xd, 0xc4, 0x24 } };

enum UAV_ACCESS_FLAG : Int32
{
    UAV_ACCESS_UNSPECIFIED = 0x00,
    
    UAV_ACCESS_FLAG_READ   = 0x01,

    UAV_ACCESS_FLAG_WRITE  = 0x02,

    UAV_ACCESS_FLAG_READ_WRITE = UAV_ACCESS_FLAG_READ | UAV_ACCESS_FLAG_WRITE
};

struct TextureViewDesc : DeviceObjectAttribs
{
    TEXTURE_VIEW_TYPE ViewType;

    RESOURCE_DIMENSION TextureDim;

    TEXTURE_FORMAT Format;
    
    Uint32 MostDetailedMip;

    Uint32 NumMipLevels;

    union
    {
        Uint32 FirstArraySlice;

        Uint32 FirstDepthSlice;
    };
    
    union
    {
        Uint32 NumArraySlices;
        
        Uint32 NumDepthSlices;
    };

    Uint32 AccessFlags;



    TextureViewDesc() : 
        ViewType( TEXTURE_VIEW_UNDEFINED ),
        TextureDim( RESOURCE_DIM_UNDEFINED ),
        Format(TEX_FORMAT_UNKNOWN),
        MostDetailedMip(0),
        NumMipLevels(0),
        FirstArraySlice(0),
        NumArraySlices(0),
        AccessFlags(0)
    {
    }


    bool operator == (const TextureViewDesc& RHS)const
    {
               // Name is primarily used for debug purposes and does not affect the view.
               // It is ignored in comparison operation.
        return //strcmp(Name, RHS.Name) == 0      &&
               ViewType     == RHS.ViewType     &&
               TextureDim  == RHS.TextureDim  &&
               Format       == RHS.Format       &&
               MostDetailedMip == RHS.MostDetailedMip &&
               NumMipLevels    == RHS.NumMipLevels    &&
               FirstArraySlice == RHS.FirstArraySlice &&
               FirstDepthSlice == RHS.FirstDepthSlice &&
               NumArraySlices  == RHS.NumArraySlices  &&
               NumDepthSlices  == RHS.NumDepthSlices &&
               AccessFlags     == RHS.AccessFlags;
    }
};


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

    virtual const TextureViewDesc& GetDesc()const = 0;

    virtual void SetSampler( class ISampler *pSampler ) = 0;


    virtual ISampler* GetSampler() = 0;
    


    virtual class ITexture* GetTexture() = 0;


    virtual void GenerateMips(IDeviceContext *pContext ) = 0;
};

}