TextureViewBase.hpp

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 "TextureView.h"
#include "DeviceObjectBase.hpp"
#include "RefCntAutoPtr.hpp"
#include "GraphicsAccessories.hpp"
 
namespace Diligent
{
 
 
template <typename EngineImplTraits>
class TextureViewBase : public DeviceObjectBase<typename EngineImplTraits::TextureViewInterface, typename EngineImplTraits::RenderDeviceImplType, TextureViewDesc>
{
public:
    // Base interface that this class inherits (ITextureViewD3D12, ITextureViewVk, etc.).
    using BaseInterface = typename EngineImplTraits::TextureViewInterface;
 
    // Render device implementation type (RenderDeviceD3D12Impl, RenderDeviceVkImpl, etc.).
    using RenderDeviceImplType = typename EngineImplTraits::RenderDeviceImplType;
 
    using TDeviceObjectBase = DeviceObjectBase<BaseInterface, RenderDeviceImplType, TextureViewDesc>;
 
 
    TextureViewBase(IReferenceCounters*    pRefCounters,
                    RenderDeviceImplType*  pDevice,
                    const TextureViewDesc& ViewDesc,
                    ITexture*              pTexture,
                    bool                   bIsDefaultView) :
        // Default views are created as part of the texture, so we cannot not keep strong
        // reference to the texture to avoid cyclic links. Instead, we will attach to the
        // reference counters of the texture.
        TDeviceObjectBase(pRefCounters, pDevice, ViewDesc),
        m_pTexture(pTexture),
        // For non-default view, we will keep strong reference to texture
        m_spTexture(bIsDefaultView ? nullptr : pTexture)
    {}
 
    IMPLEMENT_QUERY_INTERFACE_IN_PLACE(IID_TextureView, TDeviceObjectBase)
 
    
    virtual void DILIGENT_CALL_TYPE SetSampler(ISampler* pSampler) override final
    {
#ifdef DILIGENT_DEVELOPMENT
        if (this->m_Desc.ViewType != TEXTURE_VIEW_SHADER_RESOURCE)
            LOG_ERROR("Texture view \"", this->m_Desc.Name, "\": a sampler can be attached to a shader resource view only. The view type is ", GetTexViewTypeLiteralName(this->m_Desc.ViewType));
#endif
        m_pSampler = pSampler;
    }
 
    virtual ISampler* DILIGENT_CALL_TYPE GetSampler() override final
    {
        return m_pSampler;
    }
 
    const ISampler* GetSampler() const
    {
        return m_pSampler;
    }
 
    virtual ITexture* DILIGENT_CALL_TYPE GetTexture() override final
    {
        return m_pTexture;
    }
 
    const ITexture* DILIGENT_CALL_TYPE GetTexture() const
    {
        return m_pTexture;
    }
 
    template <typename TextureType>
    TextureType* GetTexture()
    {
        return ValidatedCast<TextureType>(m_pTexture);
    }
 
    template <typename TextureType>
    TextureType* GetTexture() const
    {
        return ValidatedCast<TextureType>(m_pTexture);
    }
 
protected:
    RefCntAutoPtr<ISampler> m_pSampler;
 
    ITexture* const m_pTexture;
 
    RefCntAutoPtr<ITexture> m_spTexture;
};
 
} // namespace Diligent