ShaderD3D11Impl.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 <mutex>
#include <unordered_map>
#include <atlbase.h>
#include <cstring>
 
#include "EngineD3D11ImplTraits.hpp"
#include "ShaderBase.hpp"
#include "ShaderD3DBase.hpp"
#include "ShaderResourcesD3D11.hpp"
#include "HashUtils.hpp"
 
namespace Diligent
{
 
class ShaderD3D11Impl final : public ShaderBase<EngineD3D11ImplTraits>, public ShaderD3DBase
{
public:
    using TShaderBase = ShaderBase<EngineD3D11ImplTraits>;
 
    ShaderD3D11Impl(IReferenceCounters*          pRefCounters,
                    class RenderDeviceD3D11Impl* pRenderDeviceD3D11,
                    const ShaderCreateInfo&      ShaderCI);
    ~ShaderD3D11Impl();
 
    virtual void DILIGENT_CALL_TYPE QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface) override final;
 
    virtual Uint32 DILIGENT_CALL_TYPE GetResourceCount() const override final
    {
        return m_pShaderResources->GetTotalResources();
    }
 
    virtual void DILIGENT_CALL_TYPE GetResourceDesc(Uint32 Index, ShaderResourceDesc& ResourceDesc) const override final
    {
        ResourceDesc = m_pShaderResources->GetHLSLShaderResourceDesc(Index);
    }
 
    virtual void DILIGENT_CALL_TYPE GetHLSLResource(Uint32 Index, HLSLShaderResourceDesc& ResourceDesc) const override final
    {
        ResourceDesc = m_pShaderResources->GetHLSLShaderResourceDesc(Index);
    }
 
    virtual ID3D11DeviceChild* DILIGENT_CALL_TYPE GetD3D11Shader() override final
    {
        // GetD3D11Shader(m_pShaderByteCode) should not throw as the shader must
        // already have been created.
        return GetD3D11Shader(m_pShaderByteCode);
    }
 
    ID3DBlob* GetBytecode() { return m_pShaderByteCode; }
 
    const std::shared_ptr<const ShaderResourcesD3D11>& GetShaderResources() const { return m_pShaderResources; }
 
    ID3D11DeviceChild* GetD3D11Shader(ID3DBlob* pBlob) noexcept(false);
 
private:
    struct BlobHashKey
    {
        const size_t      Hash;
        CComPtr<ID3DBlob> pBlob;
 
        explicit BlobHashKey(ID3DBlob* _pBlob) :
            Hash{ComputeHash(_pBlob)},
            pBlob{_pBlob}
        {}
 
        struct Hasher
        {
            size_t operator()(const BlobHashKey& Key) const
            {
                return Key.Hash;
            }
        };
 
        bool operator==(const BlobHashKey& rhs) const
        {
            if (Hash != rhs.Hash)
                return false;
 
            const auto Size0 = pBlob->GetBufferSize();
            const auto Size1 = rhs.pBlob->GetBufferSize();
            if (Size0 != Size1)
                return false;
 
            return memcmp(pBlob->GetBufferPointer(), rhs.pBlob->GetBufferPointer(), Size0) == 0;
        }
 
    private:
        static size_t ComputeHash(ID3DBlob* pBlob)
        {
            const auto* pData = reinterpret_cast<const Uint32*>(pBlob->GetBufferPointer());
            const auto  Size  = pBlob->GetBufferSize();
            VERIFY(Size % 4 == 0, "Bytecode size is expected to be a multiple of 4");
            size_t Hash = 0;
            for (Uint32 i = 0; i < Size / 4; ++i)
            {
                HashCombine(Hash, pData[i]);
            }
            return Hash;
        }
    };
 
    std::mutex                                                                       m_d3dShaderCacheMtx;
    std::unordered_map<BlobHashKey, CComPtr<ID3D11DeviceChild>, BlobHashKey::Hasher> m_d3dShaderCache;
 
    // ShaderResources class instance must be referenced through the shared pointer, because
    // it is referenced by ShaderResourceLayoutD3D11 class instances
    std::shared_ptr<const ShaderResourcesD3D11> m_pShaderResources;
};
 
} // namespace Diligent