DeviceContextD3D11Impl.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 "DeviceContextD3D11.h"
#include "DeviceContextBase.h"
#include "ShaderD3D11Impl.h"

#ifdef _DEBUG
#   define VERIFY_CONTEXT_BINDINGS
#endif

namespace Diligent
{

class DeviceContextD3D11Impl : public DeviceContextBase<IDeviceContextD3D11>
{
public:
    typedef DeviceContextBase<IDeviceContextD3D11> TDeviceContextBase;

    DeviceContextD3D11Impl(IReferenceCounters *pRefCounters, IMemoryAllocator &Allocator, IRenderDevice *pDevice, ID3D11DeviceContext *pd3d11DeviceContext, const struct EngineD3D11Attribs &EngineAttribs, bool bIsDeferred);
    virtual void QueryInterface( const Diligent::INTERFACE_ID &IID, IObject **ppInterface )override final;

    virtual void SetPipelineState(IPipelineState *pPipelineState)override final;

    virtual void TransitionShaderResources(IPipelineState *pPipelineState, IShaderResourceBinding *pShaderResourceBinding)override final;

    virtual void CommitShaderResources(IShaderResourceBinding *pShaderResourceBinding, Uint32 Flags)override final;

    virtual void SetStencilRef(Uint32 StencilRef)override final;

    virtual void SetBlendFactors(const float* pBlendFactors = nullptr)override final;

    virtual void SetVertexBuffers( Uint32 StartSlot, Uint32 NumBuffersSet, IBuffer **ppBuffers, Uint32 *pStrides, Uint32 *pOffsets, Uint32 Flags )override final;
    
    virtual void InvalidateState()override final;

    virtual void SetIndexBuffer( IBuffer *pIndexBuffer, Uint32 ByteOffset )override final;

    virtual void SetViewports( Uint32 NumViewports, const Viewport *pViewports, Uint32 RTWidth, Uint32 RTHeight )override final;

    virtual void SetScissorRects( Uint32 NumRects, const Rect *pRects, Uint32 RTWidth, Uint32 RTHeight )override final;

    virtual void SetRenderTargets( Uint32 NumRenderTargets, ITextureView *ppRenderTargets[], ITextureView *pDepthStencil )override final;

    virtual void Draw( DrawAttribs &DrawAttribs )override final;

    virtual void DispatchCompute( const DispatchComputeAttribs &DispatchAttrs )override final;

    virtual void ClearDepthStencil( ITextureView *pView, Uint32 ClearFlags, float fDepth, Uint8 Stencil)override final;

    virtual void ClearRenderTarget( ITextureView *pView, const float *RGBA )override final;

    virtual void Flush()override final;
    
    void FinishCommandList(class ICommandList **ppCommandList)override final;

    virtual void ExecuteCommandList(class ICommandList *pCommandList)override final;

    ID3D11DeviceContext* GetD3D11DeviceContext(){ return m_pd3d11DeviceContext; }
    
    void CommitRenderTargets();

    void ReleaseCommittedShaderResources();

    static constexpr int NumShaderTypes = 6;

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[],
                            IDeviceObject *pResToUnbind,
                            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);

    template<bool TransitionResources,
             bool CommitResources>
    void TransitionAndCommitShaderResources(IPipelineState *pPSO, IShaderResourceBinding *pShaderResourceBinding);

    void ClearStateCache();

    CComPtr<ID3D11DeviceContext> m_pd3d11DeviceContext; 

    ID3D11Buffer*              m_CommittedD3D11CBs     [NumShaderTypes][D3D11_COMMONSHADER_CONSTANT_BUFFER_API_SLOT_COUNT];
    
    ID3D11ShaderResourceView*  m_CommittedD3D11SRVs    [NumShaderTypes][D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT];
    
    ID3D11SamplerState*        m_CommittedD3D11Samplers[NumShaderTypes][D3D11_COMMONSHADER_SAMPLER_SLOT_COUNT];
    
    ID3D11UnorderedAccessView* m_CommittedD3D11UAVs    [NumShaderTypes][D3D11_PS_CS_UAV_REGISTER_COUNT];

    ID3D11Resource*  m_CommittedD3D11SRVResources    [NumShaderTypes][D3D11_COMMONSHADER_INPUT_RESOURCE_SLOT_COUNT];

    ID3D11Resource*  m_CommittedD3D11UAVResources    [NumShaderTypes][D3D11_PS_CS_UAV_REGISTER_COUNT];

    Uint8 m_NumCommittedCBs[NumShaderTypes] = {};
    Uint8 m_NumCommittedSRVs[NumShaderTypes]= {};
    Uint8 m_NumCommittedSamplers[NumShaderTypes]= {};
    Uint8 m_NumCommittedUAVs[NumShaderTypes]= {};

    ID3D11Buffer*  m_CommittedD3D11VertexBuffers[MaxBufferSlots] = {};
    UINT m_CommittedD3D11VBStrides[MaxBufferSlots];
    UINT m_CommittedD3D11VBOffsets[MaxBufferSlots];
    UINT m_NumCommittedD3D11VBs;
    bool m_bCommittedD3D11VBsUpToDate = false;

    ID3D11InputLayout *m_CommittedD3D11InputLayout = nullptr;

    CComPtr<ID3D11Buffer>  m_CommittedD3D11IndexBuffer;
    VALUE_TYPE m_CommittedIBFormat;
    Uint32 m_CommittedD3D11IndexDataStartOffset;
    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];

    Uint32 m_DebugFlags;

    FixedBlockMemoryAllocator m_CmdListAllocator;

#ifdef VERIFY_CONTEXT_BINDINGS
    void dbgVerifyRenderTargetFormats();

    template<UINT MaxResources, typename TD3D11ResourceType, typename TGetD3D11ResourcesType>
    void dbgVerifyCommittedResources(TD3D11ResourceType CommittedD3D11ResourcesArr[][MaxResources],
                                     Uint8 NumCommittedResourcesArr[],
                                     TGetD3D11ResourcesType GetD3D11ResMethods[],
                                     const Char *ResourceName,
                                     SHADER_TYPE ShaderType);

    template<UINT MaxResources, typename TD3D11ViewType>
    void dbgVerifyViewConsistency(TD3D11ViewType CommittedD3D11ViewArr[][MaxResources],
                                  ID3D11Resource* CommittedD3D11ResourcesArr[][MaxResources],
                                  Uint8 NumCommittedResourcesArr[],
                                  const Char *ResourceName,
                                  SHADER_TYPE ShaderType);

    void dbgVerifyCommittedSRVs(SHADER_TYPE ShaderType = SHADER_TYPE_UNKNOWN);

    void dbgVerifyCommittedUAVs(SHADER_TYPE ShaderType = SHADER_TYPE_UNKNOWN);

    void dbgVerifyCommittedSamplers(SHADER_TYPE ShaderType = SHADER_TYPE_UNKNOWN);

    void dbgVerifyCommittedCBs(SHADER_TYPE ShaderType = SHADER_TYPE_UNKNOWN);

    void dbgVerifyCommittedIndexBuffer();

    void dbgVerifyCommittedVertexBuffers();

    void dbgVerifyCommittedShaders();

#else
    #define dbgVerifyRenderTargetFormats(...)
    #define dbgVerifyCommittedSRVs(...)
    #define dbgVerifyCommittedUAVs(...)
    #define dbgVerifyCommittedSamplers(...)
    #define dbgVerifyCommittedCBs(...)
    #define dbgVerifyCommittedIndexBuffer(...)
    #define dbgVerifyCommittedVertexBuffers(...)
    #define dbgVerifyCommittedShaders(...)

#endif
};

}