TextureView.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
 
// clang-format off
 
 
#include "../../../Primitives/interface/FlagEnum.h"
#include "DeviceObject.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
struct ISampler;
 
// {5B2EA04E-8128-45E4-AA4D-6DC7E70DC424}
static const INTERFACE_ID IID_TextureView =
    {0x5b2ea04e, 0x8128, 0x45e4,{0xaa, 0x4d, 0x6d, 0xc7, 0xe7, 0xd, 0xc4, 0x24}};
 
// clang-format off
 
DILIGENT_TYPED_ENUM(UAV_ACCESS_FLAG, Uint8)
{
    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
};
DEFINE_FLAG_ENUM_OPERATORS(UAV_ACCESS_FLAG)
 
DILIGENT_TYPED_ENUM(TEXTURE_VIEW_FLAGS, Uint8)
{
    TEXTURE_VIEW_FLAG_NONE                      = 0x00,
 
    TEXTURE_VIEW_FLAG_ALLOW_MIP_MAP_GENERATION = 0x01,
};
DEFINE_FLAG_ENUM_OPERATORS(TEXTURE_VIEW_FLAGS)
 
 
struct TextureViewDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    TEXTURE_VIEW_TYPE ViewType     DEFAULT_INITIALIZER(TEXTURE_VIEW_UNDEFINED);
 
    RESOURCE_DIMENSION TextureDim  DEFAULT_INITIALIZER(RESOURCE_DIM_UNDEFINED);
 
    TEXTURE_FORMAT Format          DEFAULT_INITIALIZER(TEX_FORMAT_UNKNOWN);
 
    Uint32 MostDetailedMip         DEFAULT_INITIALIZER(0);
 
    Uint32 NumMipLevels            DEFAULT_INITIALIZER(0);
 
    union
    {
        Uint32 FirstArraySlice DEFAULT_INITIALIZER(0);
 
        Uint32 FirstDepthSlice;
    };
 
    union
    {
        Uint32 NumArraySlices DEFAULT_INITIALIZER(0);
 
        Uint32 NumDepthSlices;
    };
 
    UAV_ACCESS_FLAG    AccessFlags DEFAULT_INITIALIZER(UAV_ACCESS_UNSPECIFIED);
 
    TEXTURE_VIEW_FLAGS Flags       DEFAULT_INITIALIZER(TEXTURE_VIEW_FLAG_NONE);
 
#if DILIGENT_CPP_INTERFACE
 
    TextureViewDesc() noexcept {}
 
    TextureViewDesc(TEXTURE_VIEW_TYPE  _ViewType,
                    RESOURCE_DIMENSION _TextureDim,
                    TEXTURE_FORMAT     _Format                 = TextureViewDesc{}.Format,
                    Uint32             _MostDetailedMip        = TextureViewDesc{}.MostDetailedMip,
                    Uint32             _NumMipLevels           = TextureViewDesc{}.NumMipLevels,
                    Uint32             _FirstArrayOrDepthSlice = TextureViewDesc{}.FirstArraySlice,
                    Uint32             _NumArrayOrDepthSlices  = TextureViewDesc{}.NumArraySlices,
                    UAV_ACCESS_FLAG    _AccessFlags            = TextureViewDesc{}.AccessFlags,
                    TEXTURE_VIEW_FLAGS _Flags                  = TextureViewDesc{}.Flags) noexcept :
        ViewType{_ViewType},
        TextureDim{_TextureDim},
        Format{_Format},
        MostDetailedMip{_MostDetailedMip},
        NumMipLevels{_NumMipLevels},
        FirstArraySlice{_FirstArrayOrDepthSlice},
        NumArraySlices{_NumArrayOrDepthSlices},
        AccessFlags{_AccessFlags},
        Flags{_Flags}
    {}
 
 
    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;
    }
#else
 
#endif
};
typedef struct TextureViewDesc TextureViewDesc;
 
// clang-format on
 
#define DILIGENT_INTERFACE_NAME ITextureView
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define ITextureViewInclusiveMethods \
    IDeviceObjectInclusiveMethods;   \
    ITextureViewMethods TextureView
 
 
DILIGENT_BEGIN_INTERFACE(ITextureView, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
    virtual const TextureViewDesc& METHOD(GetDesc)() const override = 0;
#endif
 
    VIRTUAL void METHOD(SetSampler)(THIS_ struct ISampler * pSampler) PURE;
 
 
    VIRTUAL struct ISampler* METHOD(GetSampler)(THIS) PURE;
 
 
 
    VIRTUAL struct ITexture* METHOD(GetTexture)(THIS) PURE;
};
DILIGENT_END_INTERFACE
 
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
#if DILIGENT_C_INTERFACE
 
#    define ITextureView_GetDesc(This) (const struct TextureViewDesc*)IDeviceObject_GetDesc(This)
 
// clang-format off
 
#    define ITextureView_SetSampler(This, ...) CALL_IFACE_METHOD(TextureView, SetSampler, This, __VA_ARGS__)
#    define ITextureView_GetSampler(This)      CALL_IFACE_METHOD(TextureView, GetSampler, This)
#    define ITextureView_GetTexture(This)      CALL_IFACE_METHOD(TextureView, GetTexture, This)
 
// clang-format on
 
#endif
 
DILIGENT_END_NAMESPACE