DeviceContextD3D11Impl.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 <vector>
 
#include "EngineD3D11ImplTraits.hpp"
#include "DeviceContextBase.hpp"
#include "BufferD3D11Impl.hpp"
#include "TextureBaseD3D11.hpp"
#include "PipelineStateD3D11Impl.hpp"
#include "QueryD3D11Impl.hpp"
#include "FramebufferD3D11Impl.hpp"
#include "RenderPassD3D11Impl.hpp"
#include "DisjointQueryPool.hpp"
#include "BottomLevelASBase.hpp"
#include "TopLevelASBase.hpp"
#include "ShaderResourceBindingD3D11Impl.hpp"
 
#ifdef DILIGENT_DEVELOPMENT
#    define VERIFY_CONTEXT_BINDINGS
#endif
 
namespace Diligent
{
 
class DeviceContextD3D11Impl final : public DeviceContextBase<EngineD3D11ImplTraits>
{
public:
    using TDeviceContextBase = DeviceContextBase<EngineD3D11ImplTraits>;
 
    DeviceContextD3D11Impl(IReferenceCounters*                 pRefCounters,
                           IMemoryAllocator&                   Allocator,
                           RenderDeviceD3D11Impl*              pDevice,
                           ID3D11DeviceContext*                pd3d11DeviceContext,
                           const struct EngineD3D11CreateInfo& EngineAttribs,
                           bool                                bIsDeferred);
    virtual void DILIGENT_CALL_TYPE QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface) override final;
 
    virtual void DILIGENT_CALL_TYPE SetPipelineState(IPipelineState* pPipelineState) override final;
 
    virtual void DILIGENT_CALL_TYPE TransitionShaderResources(IPipelineState*         pPipelineState,
                                                              IShaderResourceBinding* pShaderResourceBinding) override final;
 
    virtual void DILIGENT_CALL_TYPE CommitShaderResources(IShaderResourceBinding*        pShaderResourceBinding,
                                                          RESOURCE_STATE_TRANSITION_MODE StateTransitionMode) override final;
 
    virtual void DILIGENT_CALL_TYPE SetStencilRef(Uint32 StencilRef) override final;
 
    virtual void DILIGENT_CALL_TYPE SetBlendFactors(const float* pBlendFactors = nullptr) override final;
 
    virtual void DILIGENT_CALL_TYPE SetVertexBuffers(Uint32                         StartSlot,
                                                     Uint32                         NumBuffersSet,
                                                     IBuffer**                      ppBuffers,
                                                     Uint32*                        pOffsets,
                                                     RESOURCE_STATE_TRANSITION_MODE StateTransitionMode,
                                                     SET_VERTEX_BUFFERS_FLAGS       Flags) override final;
 
    virtual void DILIGENT_CALL_TYPE InvalidateState() override final;
 
    virtual void DILIGENT_CALL_TYPE SetIndexBuffer(IBuffer*                       pIndexBuffer,
                                                   Uint32                         ByteOffset,
                                                   RESOURCE_STATE_TRANSITION_MODE StateTransitionMode) override final;
 
    virtual void DILIGENT_CALL_TYPE SetViewports(Uint32          NumViewports,
                                                 const Viewport* pViewports,
                                                 Uint32          RTWidth,
                                                 Uint32          RTHeight) override final;
 
    virtual void DILIGENT_CALL_TYPE SetScissorRects(Uint32      NumRects,
                                                    const Rect* pRects,
                                                    Uint32      RTWidth,
                                                    Uint32      RTHeight) override final;
 
    virtual void DILIGENT_CALL_TYPE SetRenderTargets(Uint32                         NumRenderTargets,
                                                     ITextureView*                  ppRenderTargets[],
                                                     ITextureView*                  pDepthStencil,
                                                     RESOURCE_STATE_TRANSITION_MODE StateTransitionMode) override final;
 
    virtual void DILIGENT_CALL_TYPE BeginRenderPass(const BeginRenderPassAttribs& Attribs) override final;
 
    virtual void DILIGENT_CALL_TYPE NextSubpass() override final;
 
    virtual void DILIGENT_CALL_TYPE EndRenderPass() override final;
 
    virtual void DILIGENT_CALL_TYPE Draw(const DrawAttribs& Attribs) override final;
    virtual void DILIGENT_CALL_TYPE DrawIndexed(const DrawIndexedAttribs& Attribs) override final;
    virtual void DILIGENT_CALL_TYPE DrawIndirect(const DrawIndirectAttribs& Attribs, IBuffer* pAttribsBuffer) override final;
    virtual void DILIGENT_CALL_TYPE DrawIndexedIndirect(const DrawIndexedIndirectAttribs& Attribs, IBuffer* pAttribsBuffer) override final;
    virtual void DILIGENT_CALL_TYPE DrawMesh(const DrawMeshAttribs& Attribs) override final;
    virtual void DILIGENT_CALL_TYPE DrawMeshIndirect(const DrawMeshIndirectAttribs& Attribs, IBuffer* pAttribsBuffer) override final;
    virtual void DILIGENT_CALL_TYPE DrawMeshIndirectCount(const DrawMeshIndirectCountAttribs& Attribs, IBuffer* pAttribsBuffer, IBuffer* pCountBuffer) override final;
 
    virtual void DILIGENT_CALL_TYPE DispatchCompute(const DispatchComputeAttribs& Attribs) override final;
    virtual void DILIGENT_CALL_TYPE DispatchComputeIndirect(const DispatchComputeIndirectAttribs& Attribs, IBuffer* pAttribsBuffer) override final;
 
    virtual void DILIGENT_CALL_TYPE ClearDepthStencil(ITextureView*                  pView,
                                                      CLEAR_DEPTH_STENCIL_FLAGS      ClearFlags,
                                                      float                          fDepth,
                                                      Uint8                          Stencil,
                                                      RESOURCE_STATE_TRANSITION_MODE StateTransitionMode) override final;
 
    virtual void DILIGENT_CALL_TYPE ClearRenderTarget(ITextureView* pView, const float* RGBA, RESOURCE_STATE_TRANSITION_MODE StateTransitionMode) override final;
 
    virtual void DILIGENT_CALL_TYPE UpdateBuffer(IBuffer*                       pBuffer,
                                                 Uint32                         Offset,
                                                 Uint32                         Size,
                                                 const void*                    pData,
                                                 RESOURCE_STATE_TRANSITION_MODE StateTransitionMode) override final;
 
    virtual void DILIGENT_CALL_TYPE CopyBuffer(IBuffer*                       pSrcBuffer,
                                               Uint32                         SrcOffset,
                                               RESOURCE_STATE_TRANSITION_MODE SrcBufferTransitionMode,
                                               IBuffer*                       pDstBuffer,
                                               Uint32                         DstOffset,
                                               Uint32                         Size,
                                               RESOURCE_STATE_TRANSITION_MODE DstBufferTransitionMode) override final;
 
    virtual void DILIGENT_CALL_TYPE MapBuffer(IBuffer* pBuffer, MAP_TYPE MapType, MAP_FLAGS MapFlags, PVoid& pMappedData) override final;
 
    virtual void DILIGENT_CALL_TYPE UnmapBuffer(IBuffer* pBuffer, MAP_TYPE MapType) override final;
 
    virtual void DILIGENT_CALL_TYPE UpdateTexture(ITexture*                      pTexture,
                                                  Uint32                         MipLevel,
                                                  Uint32                         Slice,
                                                  const Box&                     DstBox,
                                                  const TextureSubResData&       SubresData,
                                                  RESOURCE_STATE_TRANSITION_MODE SrcBufferTransitionMode,
                                                  RESOURCE_STATE_TRANSITION_MODE StateTransitionMode) override final;
 
    virtual void DILIGENT_CALL_TYPE CopyTexture(const CopyTextureAttribs& CopyAttribs) override final;
 
    virtual void DILIGENT_CALL_TYPE MapTextureSubresource(ITexture*                 pTexture,
                                                          Uint32                    MipLevel,
                                                          Uint32                    ArraySlice,
                                                          MAP_TYPE                  MapType,
                                                          MAP_FLAGS                 MapFlags,
                                                          const Box*                pMapRegion,
                                                          MappedTextureSubresource& MappedData) override final;
 
    virtual void DILIGENT_CALL_TYPE UnmapTextureSubresource(ITexture* pTexture, Uint32 MipLevel, Uint32 ArraySlice) override final;
 
    virtual void DILIGENT_CALL_TYPE GenerateMips(ITextureView* pTextureView) override final;
 
    virtual void DILIGENT_CALL_TYPE FinishFrame() override final;
 
    virtual void DILIGENT_CALL_TYPE TransitionResourceStates(Uint32 BarrierCount, StateTransitionDesc* pResourceBarriers) override final;
 
    virtual void DILIGENT_CALL_TYPE ResolveTextureSubresource(ITexture*                               pSrcTexture,
                                                              ITexture*                               pDstTexture,
                                                              const ResolveTextureSubresourceAttribs& ResolveAttribs) override final;
 
    void DILIGENT_CALL_TYPE FinishCommandList(class ICommandList** ppCommandList) override final;
 
    virtual void DILIGENT_CALL_TYPE ExecuteCommandLists(Uint32               NumCommandLists,
                                                        ICommandList* const* ppCommandLists) override final;
 
    virtual void DILIGENT_CALL_TYPE SignalFence(IFence* pFence, Uint64 Value) override final;
 
    virtual void DILIGENT_CALL_TYPE WaitForFence(IFence* pFence, Uint64 Value, bool FlushContext) override final;
 
    virtual void DILIGENT_CALL_TYPE WaitForIdle() override final;
 
    virtual void DILIGENT_CALL_TYPE BeginQuery(IQuery* pQuery) override final;
 
    virtual void DILIGENT_CALL_TYPE EndQuery(IQuery* pQuery) override final;
 
    virtual void DILIGENT_CALL_TYPE Flush() override final;
 
    virtual void DILIGENT_CALL_TYPE BuildBLAS(const BuildBLASAttribs& Attribs) override final;
 
    virtual void DILIGENT_CALL_TYPE BuildTLAS(const BuildTLASAttribs& Attribs) override final;
 
    virtual void DILIGENT_CALL_TYPE CopyBLAS(const CopyBLASAttribs& Attribs) override final;
 
    virtual void DILIGENT_CALL_TYPE CopyTLAS(const CopyTLASAttribs& Attribs) override final;
 
    virtual void DILIGENT_CALL_TYPE WriteBLASCompactedSize(const WriteBLASCompactedSizeAttribs& Attribs) override final;
 
    virtual void DILIGENT_CALL_TYPE WriteTLASCompactedSize(const WriteTLASCompactedSizeAttribs& Attribs) override final;
 
    virtual void DILIGENT_CALL_TYPE TraceRays(const TraceRaysAttribs& Attribs) override final;
 
    virtual void DILIGENT_CALL_TYPE TraceRaysIndirect(const TraceRaysIndirectAttribs& Attribs, IBuffer* pAttribsBuffer) override final;
 
    virtual void DILIGENT_CALL_TYPE UpdateSBT(IShaderBindingTable* pSBT, const UpdateIndirectRTBufferAttribs* pUpdateIndirectBufferAttribs) override final;
 
    virtual ID3D11DeviceContext* DILIGENT_CALL_TYPE GetD3D11DeviceContext() override final { return m_pd3d11DeviceContext; }
 
    void CommitRenderTargets();
 
    void ReleaseCommittedShaderResources();
 
    virtual void ResetRenderTargets() override final;
 
    void TransitionResource(TextureBaseD3D11& Texture, RESOURCE_STATE NewState, RESOURCE_STATE OldState = RESOURCE_STATE_UNKNOWN, bool UpdateResourceState = true);
    void TransitionResource(BufferD3D11Impl& Buffer, RESOURCE_STATE NewState, RESOURCE_STATE OldState = RESOURCE_STATE_UNKNOWN, bool UpdateResourceState = true);
 
private:
    void CommitD3D11IndexBuffer(VALUE_TYPE IndexType);
 
    void CommitD3D11VertexBuffers(class PipelineStateD3D11Impl* pPipelineStateD3D11);
 
    template <typename TD3D11ResourceViewType,
              typename TSetD3D11View,
              size_t NumSlots>
    void UnbindResourceView(TD3D11ResourceViewType CommittedD3D11ViewsArr[][NumSlots],
                            ID3D11Resource*        CommittedD3D11ResourcesArr[][NumSlots],
                            Uint8                  NumCommittedResourcesArr[],
                            ID3D11Resource*        pd3d11ResToUndind,
                            TSetD3D11View          SetD3D11ViewMethods[]);
 
    void UnbindTextureFromInput(TextureBaseD3D11* pTexture, ID3D11Resource* pd3d11Resource);
 
    void UnbindBufferFromInput(BufferD3D11Impl* pBuffer, ID3D11Resource* pd3d11Buffer);
 
    void UnbindResourceFromUAV(IDeviceObject* pResource, ID3D11Resource* pd3d11Resource);
 
    void UnbindTextureFromRenderTarget(TextureBaseD3D11* pResource);
 
    void UnbindTextureFromDepthStencil(TextureBaseD3D11* pTexD3D11);
 
    __forceinline void PrepareForDraw(DRAW_FLAGS Flags);
 
    __forceinline void PrepareForIndexedDraw(DRAW_FLAGS Flags, VALUE_TYPE IndexType);
 
    void BeginSubpass();
    void EndSubpass();
 
    void ClearStateCache();
 
    void BindShaderResources();
 
    static constexpr int NumShaderTypes = D3D11ResourceBindPoints::NumShaderTypes;
    struct TCommittedResources
    {
        // clang-format off
 
        ID3D11Buffer*              d3d11CBs     [NumShaderTypes][D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT] = {};
    
        ID3D11ShaderResourceView*  d3d11SRVs    [NumShaderTypes][D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT] = {};
    
        ID3D11SamplerState*        d3d11Samplers[NumShaderTypes][D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT] = {};
    
        ID3D11UnorderedAccessView* d3d11UAVs    [NumShaderTypes][D3D11_PS_CS_UAV_REGISTER_COUNT] = {};
 
        ID3D11Resource*  d3d11SRVResources      [NumShaderTypes][D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT] = {};
 
        ID3D11Resource*  d3d11UAVResources      [NumShaderTypes][D3D11_PS_CS_UAV_REGISTER_COUNT] = {};
 
        Uint8 NumCBs     [NumShaderTypes] = {};
        Uint8 NumSRVs    [NumShaderTypes] = {};
        Uint8 NumSamplers[NumShaderTypes] = {};
        Uint8 NumUAVs    [NumShaderTypes] = {};
 
        // clang-format on
 
        void Clear()
        {
            *this = {};
        }
    };
 
    enum PixelShaderUAVBindMode
    {
        Clear = 0,
        Keep,
        Bind
    };
 
    void BindCacheResources(const ShaderResourceCacheD3D11&    ResourceCache,
                            const D3D11ShaderResourceCounters& BaseBindings,
                            PixelShaderUAVBindMode&            PsUavBindMode);
 
#ifdef DILIGENT_DEVELOPMENT
    void DvpValidateCommittedShaderResources();
#endif
 
    std::shared_ptr<DisjointQueryPool::DisjointQueryWrapper> BeginDisjointQuery();
 
    CComPtr<ID3D11DeviceContext> m_pd3d11DeviceContext; 
 
    struct BindInfo : CommittedShaderResources
    {
        // Shader stages that are active in current PSO.
        SHADER_TYPE ActiveStages = SHADER_TYPE_UNKNOWN;
 
#ifdef DILIGENT_DEVELOPMENT
        // Base bindings that were used in the last BindShaderResources() call.
        std::array<D3D11ShaderResourceCounters, MAX_RESOURCE_SIGNATURES> BaseBindings = {};
#endif
        void Invalidate()
        {
            *this = {};
        }
    } m_BindInfo;
 
    TCommittedResources m_CommittedRes;
 
    ID3D11Buffer* m_CommittedD3D11VertexBuffers[MAX_BUFFER_SLOTS] = {};
    UINT m_CommittedD3D11VBStrides[MAX_BUFFER_SLOTS] = {};
    UINT m_CommittedD3D11VBOffsets[MAX_BUFFER_SLOTS] = {};
    UINT m_NumCommittedD3D11VBs = 0;
    bool m_bCommittedD3D11VBsUpToDate = false;
 
    ID3D11InputLayout* m_CommittedD3D11InputLayout = nullptr;
 
    CComPtr<ID3D11Buffer> m_CommittedD3D11IndexBuffer;
    VALUE_TYPE m_CommittedIBFormat = VT_UNDEFINED;
    Uint32 m_CommittedD3D11IndexDataStartOffset = 0;
    bool m_bCommittedD3D11IBUpToDate = false;
 
    D3D11_PRIMITIVE_TOPOLOGY m_CommittedD3D11PrimTopology = D3D11_PRIMITIVE_TOPOLOGY_UNDEFINED;
    PRIMITIVE_TOPOLOGY       m_CommittedPrimitiveTopology = PRIMITIVE_TOPOLOGY_UNDEFINED;
 
    CComPtr<ID3D11DeviceChild> m_CommittedD3DShaders[NumShaderTypes];
 
    const Uint32 m_DebugFlags;
 
    FixedBlockMemoryAllocator m_CmdListAllocator;
 
    DisjointQueryPool                                        m_DisjointQueryPool;
    std::shared_ptr<DisjointQueryPool::DisjointQueryWrapper> m_ActiveDisjointQuery;
 
    std::vector<OptimizedClearValue> m_AttachmentClearValues;
 
#ifdef VERIFY_CONTEXT_BINDINGS
 
    template <UINT MaxResources, typename TD3D11ResourceType, typename TGetD3D11ResourcesType>
    void DvpVerifyCommittedResources(TD3D11ResourceType     CommittedD3D11ResourcesArr[][MaxResources],
                                     Uint8                  NumCommittedResourcesArr[],
                                     TGetD3D11ResourcesType GetD3D11ResMethods[],
                                     const Char*            ResourceName,
                                     SHADER_TYPE            ShaderStages);
 
    template <UINT MaxResources, typename TD3D11ViewType>
    void DvpVerifyViewConsistency(TD3D11ViewType  CommittedD3D11ViewArr[][MaxResources],
                                  ID3D11Resource* CommittedD3D11ResourcesArr[][MaxResources],
                                  Uint8           NumCommittedResourcesArr[],
                                  const Char*     ResourceName,
                                  SHADER_TYPE     ShaderStages);
 
    void DvpVerifyCommittedSRVs(SHADER_TYPE ShaderStages);
 
    void DvpVerifyCommittedUAVs(SHADER_TYPE ShaderStages);
 
    void DvpVerifyCommittedSamplers(SHADER_TYPE ShaderStages);
 
    void DvpVerifyCommittedCBs(SHADER_TYPE ShaderStages);
 
    void DvpVerifyCommittedIndexBuffer();
 
    void DvpVerifyCommittedVertexBuffers();
 
    void DvpVerifyCommittedShaders();
 
#endif // VERIFY_CONTEXT_BINDINGS
};
 
} // namespace Diligent