PipelineState.h

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
 
// clang-format off
 
 
#include "../../../Primitives/interface/Object.h"
#include "../../../Platforms/interface/PlatformDefinitions.h"
#include "GraphicsTypes.h"
#include "BlendState.h"
#include "RasterizerState.h"
#include "DepthStencilState.h"
#include "InputLayout.h"
#include "ShaderResourceBinding.h"
#include "ShaderResourceVariable.h"
#include "Shader.h"
#include "Sampler.h"
#include "RenderPass.h"
#include "PipelineResourceSignature.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
    
 
struct SampleDesc
{
    Uint8 Count     DEFAULT_INITIALIZER(1);
 
    Uint8 Quality   DEFAULT_INITIALIZER(0);
 
#if DILIGENT_CPP_INTERFACE
    SampleDesc()noexcept{}
 
    SampleDesc(Uint8 _Count, Uint8 _Quality) noexcept : 
        Count   {_Count  },
        Quality {_Quality}
    {}
#endif
};
typedef struct SampleDesc SampleDesc;
 
 
struct ShaderResourceVariableDesc
{
    SHADER_TYPE                   ShaderStages DEFAULT_INITIALIZER(SHADER_TYPE_UNKNOWN);
 
    const Char*                   Name         DEFAULT_INITIALIZER(nullptr);
 
    SHADER_RESOURCE_VARIABLE_TYPE Type         DEFAULT_INITIALIZER(SHADER_RESOURCE_VARIABLE_TYPE_STATIC);
 
#if DILIGENT_CPP_INTERFACE
    ShaderResourceVariableDesc()noexcept{}
 
    ShaderResourceVariableDesc(SHADER_TYPE _ShaderStages, const Char* _Name, SHADER_RESOURCE_VARIABLE_TYPE _Type)noexcept : 
        ShaderStages{_ShaderStages},
        Name        {_Name        },
        Type        {_Type        }
    {}
#endif
};
typedef struct ShaderResourceVariableDesc ShaderResourceVariableDesc;
 
 
struct PipelineResourceLayoutDesc
{
    SHADER_RESOURCE_VARIABLE_TYPE       DefaultVariableType  DEFAULT_INITIALIZER(SHADER_RESOURCE_VARIABLE_TYPE_STATIC);
 
    Uint32                              NumVariables         DEFAULT_INITIALIZER(0);
 
 
    const ShaderResourceVariableDesc*   Variables            DEFAULT_INITIALIZER(nullptr);
                                                            
    Uint32                              NumImmutableSamplers DEFAULT_INITIALIZER(0);
                                                            
    const ImmutableSamplerDesc*         ImmutableSamplers    DEFAULT_INITIALIZER(nullptr);
};
typedef struct PipelineResourceLayoutDesc PipelineResourceLayoutDesc;
 
 
 
struct GraphicsPipelineDesc
{
    BlendStateDesc BlendDesc;
 
    Uint32 SampleMask DEFAULT_INITIALIZER(0xFFFFFFFF);
 
    RasterizerStateDesc RasterizerDesc;
 
    DepthStencilStateDesc DepthStencilDesc;
 
    InputLayoutDesc InputLayout;
    //D3D12_INDEX_BUFFER_STRIP_CUT_VALUE IBStripCutValue;
 
    PRIMITIVE_TOPOLOGY PrimitiveTopology DEFAULT_INITIALIZER(PRIMITIVE_TOPOLOGY_TRIANGLE_LIST);
 
    Uint8 NumViewports           DEFAULT_INITIALIZER(1);
 
    Uint8 NumRenderTargets       DEFAULT_INITIALIZER(0);
 
    Uint8 SubpassIndex           DEFAULT_INITIALIZER(0);
 
    TEXTURE_FORMAT RTVFormats[8] DEFAULT_INITIALIZER({});
 
    TEXTURE_FORMAT DSVFormat     DEFAULT_INITIALIZER(TEX_FORMAT_UNKNOWN);
 
    SampleDesc SmplDesc;
 
 
    IRenderPass* pRenderPass     DEFAULT_INITIALIZER(nullptr);
 
    Uint32 NodeMask DEFAULT_INITIALIZER(0);
 
    //D3D12_CACHED_PIPELINE_STATE CachedPSO;
    //D3D12_PIPELINE_STATE_FLAGS Flags;
};
typedef struct GraphicsPipelineDesc GraphicsPipelineDesc;
 
 
struct RayTracingGeneralShaderGroup
{
    const char* Name    DEFAULT_INITIALIZER(nullptr);
 
    IShader*    pShader DEFAULT_INITIALIZER(nullptr);
 
#if DILIGENT_CPP_INTERFACE
    RayTracingGeneralShaderGroup() noexcept
    {}
 
    RayTracingGeneralShaderGroup(const char* _Name,
                                 IShader*    _pShader) noexcept:
        Name   {_Name   },
        pShader{_pShader}
    {}
#endif
};
typedef struct RayTracingGeneralShaderGroup RayTracingGeneralShaderGroup;
 
struct RayTracingTriangleHitShaderGroup
{
    const char* Name              DEFAULT_INITIALIZER(nullptr);
 
    IShader*    pClosestHitShader DEFAULT_INITIALIZER(nullptr);
 
    IShader*    pAnyHitShader     DEFAULT_INITIALIZER(nullptr); // can be null
 
#if DILIGENT_CPP_INTERFACE
    RayTracingTriangleHitShaderGroup() noexcept
    {}
 
    RayTracingTriangleHitShaderGroup(const char* _Name,
                                     IShader*    _pClosestHitShader,
                                     IShader*    _pAnyHitShader    = nullptr) noexcept:
        Name             {_Name             },
        pClosestHitShader{_pClosestHitShader},
        pAnyHitShader    {_pAnyHitShader    }
    {}
#endif
};
typedef struct RayTracingTriangleHitShaderGroup RayTracingTriangleHitShaderGroup;
 
struct RayTracingProceduralHitShaderGroup
{
    const char* Name                DEFAULT_INITIALIZER(nullptr);
 
    IShader*    pIntersectionShader DEFAULT_INITIALIZER(nullptr);
    
    IShader*    pClosestHitShader   DEFAULT_INITIALIZER(nullptr);
    
    IShader*    pAnyHitShader       DEFAULT_INITIALIZER(nullptr);
 
#if DILIGENT_CPP_INTERFACE
    RayTracingProceduralHitShaderGroup() noexcept
    {}
 
    RayTracingProceduralHitShaderGroup(const char* _Name,
                                       IShader*    _pIntersectionShader,
                                       IShader*    _pClosestHitShader  = nullptr,
                                       IShader*    _pAnyHitShader      = nullptr) noexcept:
        Name               {_Name               },
        pIntersectionShader{_pIntersectionShader},
        pClosestHitShader  {_pClosestHitShader  },
        pAnyHitShader      {_pAnyHitShader      }
    {}
#endif
};
typedef struct RayTracingProceduralHitShaderGroup RayTracingProceduralHitShaderGroup;
 
struct RayTracingPipelineDesc
{
    Uint16  ShaderRecordSize   DEFAULT_INITIALIZER(0);
 
    Uint8   MaxRecursionDepth  DEFAULT_INITIALIZER(0);
};
typedef struct RayTracingPipelineDesc RayTracingPipelineDesc;
 
DILIGENT_TYPED_ENUM(PIPELINE_TYPE, Uint8)
{
    PIPELINE_TYPE_GRAPHICS,
 
    PIPELINE_TYPE_COMPUTE,
 
    PIPELINE_TYPE_MESH,
 
    PIPELINE_TYPE_RAY_TRACING,
 
    PIPELINE_TYPE_LAST = PIPELINE_TYPE_RAY_TRACING,
 
    PIPELINE_TYPE_INVALID = 0xFF
};
 
 
struct PipelineStateDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    PIPELINE_TYPE PipelineType      DEFAULT_INITIALIZER(PIPELINE_TYPE_GRAPHICS);
 
 
    Uint32 SRBAllocationGranularity DEFAULT_INITIALIZER(1);
 
    Uint64 CommandQueueMask         DEFAULT_INITIALIZER(1);
 
    PipelineResourceLayoutDesc ResourceLayout;
 
#if DILIGENT_CPP_INTERFACE
    bool IsAnyGraphicsPipeline() const { return PipelineType == PIPELINE_TYPE_GRAPHICS || PipelineType == PIPELINE_TYPE_MESH; }
    bool IsComputePipeline()     const { return PipelineType == PIPELINE_TYPE_COMPUTE; }
    bool IsRayTracingPipeline()  const { return PipelineType == PIPELINE_TYPE_RAY_TRACING; }
#endif
};
typedef struct PipelineStateDesc PipelineStateDesc;
 
 
DILIGENT_TYPED_ENUM(PSO_CREATE_FLAGS, Uint32)
{
    PSO_CREATE_FLAG_NONE                              = 0x00,
 
 
    PSO_CREATE_FLAG_IGNORE_MISSING_VARIABLES          = 0x01,
 
 
    PSO_CREATE_FLAG_IGNORE_MISSING_IMMUTABLE_SAMPLERS = 0x02,
};
DEFINE_FLAG_ENUM_OPERATORS(PSO_CREATE_FLAGS);
 
 
struct PipelineStateCreateInfo
{
    PipelineStateDesc PSODesc;
 
    PSO_CREATE_FLAGS  Flags      DEFAULT_INITIALIZER(PSO_CREATE_FLAG_NONE);
 
    IPipelineResourceSignature** ppResourceSignatures DEFAULT_INITIALIZER(nullptr);
    
    Uint32 ResourceSignaturesCount DEFAULT_INITIALIZER(0);
};
typedef struct PipelineStateCreateInfo PipelineStateCreateInfo;
 
 
struct GraphicsPipelineStateCreateInfo DILIGENT_DERIVE(PipelineStateCreateInfo)
    
    GraphicsPipelineDesc GraphicsPipeline; 
     
    IShader* pVS DEFAULT_INITIALIZER(nullptr);
 
    IShader* pPS DEFAULT_INITIALIZER(nullptr);
 
    IShader* pDS DEFAULT_INITIALIZER(nullptr);
 
    IShader* pHS DEFAULT_INITIALIZER(nullptr);
 
    IShader* pGS DEFAULT_INITIALIZER(nullptr);
    
    IShader* pAS DEFAULT_INITIALIZER(nullptr);
    
    IShader* pMS DEFAULT_INITIALIZER(nullptr);
};
typedef struct GraphicsPipelineStateCreateInfo GraphicsPipelineStateCreateInfo;
 
 
struct ComputePipelineStateCreateInfo DILIGENT_DERIVE(PipelineStateCreateInfo)
    
    IShader* pCS DEFAULT_INITIALIZER(nullptr);
 
#if DILIGENT_CPP_INTERFACE
    ComputePipelineStateCreateInfo() noexcept
    {
        PSODesc.PipelineType = PIPELINE_TYPE_COMPUTE;
    }
#endif
};
typedef struct ComputePipelineStateCreateInfo ComputePipelineStateCreateInfo;
 
 
struct RayTracingPipelineStateCreateInfo DILIGENT_DERIVE(PipelineStateCreateInfo)
    
    RayTracingPipelineDesc                    RayTracingPipeline;
 
    const RayTracingGeneralShaderGroup*       pGeneralShaders          DEFAULT_INITIALIZER(nullptr);
    
    Uint32                                    GeneralShaderCount       DEFAULT_INITIALIZER(0);
    
    const RayTracingTriangleHitShaderGroup*   pTriangleHitShaders      DEFAULT_INITIALIZER(nullptr);
    
    Uint32                                    TriangleHitShaderCount   DEFAULT_INITIALIZER(0);
    
    const RayTracingProceduralHitShaderGroup* pProceduralHitShaders    DEFAULT_INITIALIZER(nullptr);
    
    Uint32                                    ProceduralHitShaderCount DEFAULT_INITIALIZER(0);
    
    const char*                               pShaderRecordName        DEFAULT_INITIALIZER(nullptr);
    
    Uint32                                    MaxAttributeSize         DEFAULT_INITIALIZER(0);
    
    Uint32                                    MaxPayloadSize           DEFAULT_INITIALIZER(0);
 
#if DILIGENT_CPP_INTERFACE
    RayTracingPipelineStateCreateInfo() noexcept
    {
        PSODesc.PipelineType = PIPELINE_TYPE_RAY_TRACING;
    }
#endif
};
typedef struct RayTracingPipelineStateCreateInfo RayTracingPipelineStateCreateInfo;
 
 
// {06084AE5-6A71-4FE8-84B9-395DD489A28C}
static const struct INTERFACE_ID IID_PipelineState =
    {0x6084ae5, 0x6a71, 0x4fe8, {0x84, 0xb9, 0x39, 0x5d, 0xd4, 0x89, 0xa2, 0x8c}};
 
#define DILIGENT_INTERFACE_NAME IPipelineState
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define IPipelineStateInclusiveMethods \
    IDeviceObjectInclusiveMethods;     \
    IPipelineStateMethods PipelineState
 
// clang-format off
 
DILIGENT_BEGIN_INTERFACE(IPipelineState, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
    virtual const PipelineStateDesc& METHOD(GetDesc)() const override = 0;
#endif
 
    VIRTUAL const GraphicsPipelineDesc REF METHOD(GetGraphicsPipelineDesc)(THIS) CONST PURE;
    
    VIRTUAL const RayTracingPipelineDesc REF METHOD(GetRayTracingPipelineDesc)(THIS) CONST PURE;
 
 
 
    VIRTUAL void METHOD(BindStaticResources)(THIS_
                                             Uint32             ShaderFlags,
                                             IResourceMapping*  pResourceMapping,
                                             Uint32             Flags) PURE;
 
    
 
    VIRTUAL Uint32 METHOD(GetStaticVariableCount)(THIS_
                                                  SHADER_TYPE ShaderType) CONST PURE;
 
    
    
    VIRTUAL IShaderResourceVariable* METHOD(GetStaticVariableByName)(THIS_
                                                                     SHADER_TYPE ShaderType,
                                                                     const Char* Name) PURE;
 
    
 
    VIRTUAL IShaderResourceVariable* METHOD(GetStaticVariableByIndex)(THIS_
                                                                      SHADER_TYPE ShaderType,
                                                                      Uint32      Index) PURE;
 
 
 
    VIRTUAL void METHOD(CreateShaderResourceBinding)(THIS_
                                                     IShaderResourceBinding** ppShaderResourceBinding,
                                                     bool                     InitStaticResources DEFAULT_VALUE(false)) PURE;
 
 
 
 
    VIRTUAL void METHOD(InitializeStaticSRBResources)(THIS_
                                                      struct IShaderResourceBinding* pShaderResourceBinding) CONST PURE;
 
 
 
    VIRTUAL bool METHOD(IsCompatibleWith)(THIS_
                                          const struct IPipelineState* pPSO) CONST PURE;
 
 
 
    VIRTUAL Uint32 METHOD(GetResourceSignatureCount)(THIS) CONST PURE;
 
 
    VIRTUAL IPipelineResourceSignature* METHOD(GetResourceSignature)(THIS_
                                                                     Uint32 Index) CONST PURE;
};
DILIGENT_END_INTERFACE
 
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
#if DILIGENT_C_INTERFACE
 
// clang-format off
 
#    define IPipelineState_GetDesc(This) (const struct PipelineStateDesc*)IDeviceObject_GetDesc(This)
 
#    define IPipelineState_GetGraphicsPipelineDesc(This)           CALL_IFACE_METHOD(PipelineState, GetGraphicsPipelineDesc,      This)
#    define IPipelineState_GetRayTracingPipelineDesc(This)         CALL_IFACE_METHOD(PipelineState, GetRayTracingPipelineDesc,    This)
#    define IPipelineState_BindStaticResources(This, ...)          CALL_IFACE_METHOD(PipelineState, BindStaticResources,          This, __VA_ARGS__)
#    define IPipelineState_GetStaticVariableCount(This, ...)       CALL_IFACE_METHOD(PipelineState, GetStaticVariableCount,       This, __VA_ARGS__)
#    define IPipelineState_GetStaticVariableByName(This, ...)      CALL_IFACE_METHOD(PipelineState, GetStaticVariableByName,      This, __VA_ARGS__)
#    define IPipelineState_GetStaticVariableByIndex(This, ...)     CALL_IFACE_METHOD(PipelineState, GetStaticVariableByIndex,     This, __VA_ARGS__)
#    define IPipelineState_CreateShaderResourceBinding(This, ...)  CALL_IFACE_METHOD(PipelineState, CreateShaderResourceBinding,  This, __VA_ARGS__)
#    define IPipelineState_InitializeStaticSRBResources(This, ...) CALL_IFACE_METHOD(PipelineState, InitializeStaticSRBResources, This, __VA_ARGS__)
#    define IPipelineState_IsCompatibleWith(This, ...)             CALL_IFACE_METHOD(PipelineState, IsCompatibleWith,             This, __VA_ARGS__)
#    define IPipelineState_GetResourceSignatureCount(This)         CALL_IFACE_METHOD(PipelineState, GetResourceSignatureCount,    This)
#    define IPipelineState_GetResourceSignature(This, ...)         CALL_IFACE_METHOD(PipelineState, GetResourceSignature,         This, __VA_ARGS__)
 
// clang-format on
 
#endif
 
DILIGENT_END_NAMESPACE