DeviceContext.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 "Object.h"
#include "DeviceCaps.h"
#include "Constants.h"
#include "Buffer.h"
#include "InputLayout.h"
#include "Shader.h"
#include "Texture.h"
#include "Sampler.h"
#include "ResourceMapping.h"
#include "TextureView.h"
#include "BufferView.h"
#include "DepthStencilState.h"
#include "BlendState.h"
#include "PipelineState.h"
#include "CommandList.h"
#include "SwapChain.h"

namespace Diligent
{

// {DC92711B-A1BE-4319-B2BD-C662D1CC19E4}
static constexpr INTERFACE_ID IID_DeviceContext =
{ 0xdc92711b, 0xa1be, 0x4319, { 0xb2, 0xbd, 0xc6, 0x62, 0xd1, 0xcc, 0x19, 0xe4 } };


enum PRIMITIVE_TOPOLOGY : Int32
{
    PRIMITIVE_TOPOLOGY_UNDEFINED = 0,
    
    PRIMITIVE_TOPOLOGY_TRIANGLE_LIST,

    PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP,

    PRIMITIVE_TOPOLOGY_POINT_LIST,

    PRIMITIVE_TOPOLOGY_LINE_LIST,

    PRIMITIVE_TOPOLOGY_1_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_2_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_3_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_4_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_5_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_6_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_7_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_8_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_9_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_10_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_11_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_12_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_13_CONTROL_POINT_PATCHLIST,
        
    PRIMITIVE_TOPOLOGY_14_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_15_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_16_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_17_CONTROL_POINT_PATCHLIST,
    
    PRIMITIVE_TOPOLOGY_18_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_19_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_20_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_21_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_22_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_23_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_24_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_25_CONTROL_POINT_PATCHLIST,
    
    PRIMITIVE_TOPOLOGY_26_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_27_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_28_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_29_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_30_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_31_CONTROL_POINT_PATCHLIST,
    
    PRIMITIVE_TOPOLOGY_32_CONTROL_POINT_PATCHLIST,

    PRIMITIVE_TOPOLOGY_NUM_TOPOLOGIES
};


struct DrawAttribs
{
    PRIMITIVE_TOPOLOGY Topology;
    union
    {
        Uint32 NumVertices;
        
        Uint32 NumIndices;
    };
    VALUE_TYPE IndexType;

    Bool IsIndexed;

    Uint32 NumInstances;

    Bool IsIndirect;

    Uint32 BaseVertex; 

    Uint32 IndirectDrawArgsOffset;

    union
    {
        Uint32 StartVertexLocation;  

        Uint32 FirstIndexLocation; 
    };
    Uint32 FirstInstanceLocation;  

    IBuffer *pIndirectDrawAttribs;



    DrawAttribs() : 
        Topology(PRIMITIVE_TOPOLOGY_UNDEFINED),
        NumVertices(0),
        IndexType(VT_UNDEFINED),
        IsIndexed(False),
        NumInstances(1),
        IsIndirect(False),
        BaseVertex(0),
        IndirectDrawArgsOffset(0),
        StartVertexLocation(0),
        FirstInstanceLocation(0),
        pIndirectDrawAttribs(nullptr)
    {}
};


enum CLEAR_DEPTH_STENCIL_FLAGS : Int32
{
    CLEAR_DEPTH_FLAG = 0x01,    
    CLEAR_STENCIL_FLAG = 0x02   
};


struct DispatchComputeAttribs
{
    Uint32 ThreadGroupCountX; 
    Uint32 ThreadGroupCountY; 
    Uint32 ThreadGroupCountZ; 

    IBuffer *pIndirectDispatchAttribs;
    
    Uint32  DispatchArgsByteOffset;

    
    DispatchComputeAttribs( Uint32 GroupsX = 1, Uint32 GroupsY = 1, Uint32 GroupsZ = 1 ) : 
        ThreadGroupCountX( GroupsX ),
        ThreadGroupCountY( GroupsY ),
        ThreadGroupCountZ( GroupsZ ),
        pIndirectDispatchAttribs(nullptr),
        DispatchArgsByteOffset(0)
    {}


    DispatchComputeAttribs( IBuffer *pDispatchAttribs, Uint32 Offset = 0 ) :
        ThreadGroupCountX( 0 ),
        ThreadGroupCountY( 0 ),
        ThreadGroupCountZ( 0 ),
        pIndirectDispatchAttribs( pDispatchAttribs ),
        DispatchArgsByteOffset( Offset )
    {}
};

enum SET_VERTEX_BUFFERS_FLAGS : Int32
{
    SET_VERTEX_BUFFERS_FLAG_RESET = 0x01
};

enum COMMIT_SHADER_RESOURCES_FLAG
{

    COMMIT_SHADER_RESOURCES_FLAG_TRANSITION_RESOURCES = 0x01
};



struct Viewport
{
    Float32 TopLeftX;

    Float32 TopLeftY;

    Float32 Width;

    Float32 Height;

    Float32 MinDepth;

    Float32 MaxDepth;

    Viewport(Float32 _TopLeftX = 0, Float32 _TopLeftY = 0,
              Float32 _Width = 0, Float32 _Height = 0,
              Float32 _MinDepth = 0, Float32 _MaxDepth = 1 )
              :
        TopLeftX( _TopLeftX ),
        TopLeftY( _TopLeftY ),
        Width   ( _Width    ),
        Height  ( _Height   ),
        MinDepth( _MinDepth ),
        MaxDepth( _MaxDepth )
    {}
};


struct Rect
{
    Int32 left;  
    Int32 top;   
    Int32 right; 
    Int32 bottom;

    Rect( Int32 _left = 0, Int32 _top = 0, Int32 _right = 0, Int32 _bottom = 0 ) : 
        left  ( _left   ),
        top   ( _top    ),
        right ( _right  ),
        bottom( _bottom )
    {}
};



class IDeviceContext : public IObject
{
public:
    virtual void QueryInterface( const Diligent::INTERFACE_ID &IID, IObject **ppInterface ) = 0;


    virtual void SetPipelineState(IPipelineState *pPipelineState) = 0;


    virtual void TransitionShaderResources(IPipelineState *pPipelineState, IShaderResourceBinding *pShaderResourceBinding) = 0;


    virtual void CommitShaderResources(IShaderResourceBinding *pShaderResourceBinding, Uint32 Flags) = 0;


    virtual void SetStencilRef(Uint32 StencilRef) = 0;

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



    //                          The vertex buffers must have been created with the Diligent::BIND_VERTEX_BUFFER flag.
    virtual void SetVertexBuffers(Uint32 StartSlot, 
                                  Uint32 NumBuffersSet, 
                                  IBuffer **ppBuffers, 
                                  Uint32 *pStrides, 
                                  Uint32 *pOffsets,
                                  Uint32 Flags) = 0;


    virtual void InvalidateState() = 0;


    
    virtual void SetIndexBuffer(IBuffer *pIndexBuffer, Uint32 ByteOffset) = 0;



    virtual void SetViewports( Uint32 NumViewports, const Viewport *pViewports, Uint32 RTWidth, Uint32 RTHeight ) = 0;


    virtual void SetScissorRects( Uint32 NumRects, const Rect *pRects, Uint32 RTWidth, Uint32 RTHeight ) = 0;


    virtual void SetRenderTargets( Uint32 NumRenderTargets, ITextureView *ppRenderTargets[], ITextureView *pDepthStencil ) = 0;


    virtual void Draw(DrawAttribs &DrawAttribs) = 0;
    
    
    virtual void DispatchCompute( const DispatchComputeAttribs &DispatchAttrs ) = 0;

    
    virtual void ClearDepthStencil( ITextureView *pView, Uint32 ClearFlags = CLEAR_DEPTH_FLAG, float fDepth = 1.f, Uint8 Stencil = 0 ) = 0;


    virtual void ClearRenderTarget( ITextureView *pView, const float *RGBA = nullptr ) = 0;

    
    virtual void FinishCommandList( ICommandList **ppCommandList) = 0;


    virtual void ExecuteCommandList( ICommandList *pCommandList) = 0;

    virtual void Flush() = 0;


    virtual void SetSwapChain( ISwapChain *pSwapChain) = 0;
};

}