RenderPass.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 "DeviceObject.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
// {B818DEC7-174D-447A-A8E4-94D21C57B40A}
static const struct INTERFACE_ID IID_RenderPass =
    { 0xb818dec7, 0x174d, 0x447a, { 0xa8, 0xe4, 0x94, 0xd2, 0x1c, 0x57, 0xb4, 0xa } };
 
 
DILIGENT_TYPED_ENUM(ATTACHMENT_LOAD_OP, Uint8)
{
    ATTACHMENT_LOAD_OP_LOAD = 0,
 
    ATTACHMENT_LOAD_OP_CLEAR,
 
    ATTACHMENT_LOAD_OP_DISCARD
};
 
 
DILIGENT_TYPED_ENUM(ATTACHMENT_STORE_OP, Uint8)
{
    ATTACHMENT_STORE_OP_STORE = 0,
 
    ATTACHMENT_STORE_OP_DISCARD
};
 
 
 
struct RenderPassAttachmentDesc
{
    TEXTURE_FORMAT          Format          DEFAULT_INITIALIZER(TEX_FORMAT_UNKNOWN);
 
    Uint8                   SampleCount     DEFAULT_INITIALIZER(1);
 
    ATTACHMENT_LOAD_OP      LoadOp          DEFAULT_INITIALIZER(ATTACHMENT_LOAD_OP_LOAD);
 
    ATTACHMENT_STORE_OP     StoreOp         DEFAULT_INITIALIZER(ATTACHMENT_STORE_OP_STORE);
 
    ATTACHMENT_LOAD_OP      StencilLoadOp   DEFAULT_INITIALIZER(ATTACHMENT_LOAD_OP_LOAD);
 
    ATTACHMENT_STORE_OP     StencilStoreOp  DEFAULT_INITIALIZER(ATTACHMENT_STORE_OP_STORE);
 
    RESOURCE_STATE          InitialState    DEFAULT_INITIALIZER(RESOURCE_STATE_UNKNOWN);
 
    RESOURCE_STATE          FinalState      DEFAULT_INITIALIZER(RESOURCE_STATE_UNKNOWN);
 
 
#if DILIGENT_CPP_INTERFACE
 
    bool operator == (const RenderPassAttachmentDesc& RHS)const
    {
        return  Format          == RHS.Format         &&
                SampleCount     == RHS.SampleCount    &&
                LoadOp          == RHS.LoadOp         &&
                StoreOp         == RHS.StoreOp        &&
                StencilLoadOp   == RHS.StencilLoadOp  &&
                StencilStoreOp  == RHS.StencilStoreOp &&
                InitialState    == RHS.InitialState   &&
                FinalState      == RHS.FinalState;
    }
#endif
};
typedef struct RenderPassAttachmentDesc RenderPassAttachmentDesc;
 
#define ATTACHMENT_UNUSED (~0U)
 
struct AttachmentReference
{
    Uint32          AttachmentIndex DEFAULT_INITIALIZER(0);
 
    RESOURCE_STATE  State           DEFAULT_INITIALIZER(RESOURCE_STATE_UNKNOWN);
 
#if DILIGENT_CPP_INTERFACE
    AttachmentReference()noexcept{}
 
    AttachmentReference(Uint32          _AttachmentIndex,
                        RESOURCE_STATE  _State)noexcept : 
        AttachmentIndex{_AttachmentIndex},
        State          {_State}
    {}
 
 
    bool operator == (const AttachmentReference& RHS) const
    {
        return  AttachmentIndex == RHS.AttachmentIndex &&
                State           == RHS.State;
    }
 
    bool operator != (const AttachmentReference& RHS) const
    {
        return !(*this == RHS);
    }
#endif
};
typedef struct AttachmentReference AttachmentReference;
 
 
struct SubpassDesc
{
    Uint32                      InputAttachmentCount        DEFAULT_INITIALIZER(0);
 
    const AttachmentReference*  pInputAttachments           DEFAULT_INITIALIZER(nullptr);
 
    Uint32                      RenderTargetAttachmentCount DEFAULT_INITIALIZER(0);
 
 
    const AttachmentReference*  pRenderTargetAttachments    DEFAULT_INITIALIZER(nullptr);
 
 
    const AttachmentReference*  pResolveAttachments         DEFAULT_INITIALIZER(nullptr);
 
    const AttachmentReference*  pDepthStencilAttachment     DEFAULT_INITIALIZER(nullptr);
 
    Uint32                      PreserveAttachmentCount     DEFAULT_INITIALIZER(0);
 
    const Uint32*               pPreserveAttachments        DEFAULT_INITIALIZER(nullptr);
 
#if DILIGENT_CPP_INTERFACE
 
    bool operator == (const SubpassDesc& RHS)const
    {
        if (InputAttachmentCount        != RHS.InputAttachmentCount ||
            RenderTargetAttachmentCount != RHS.RenderTargetAttachmentCount ||
            PreserveAttachmentCount     != RHS.PreserveAttachmentCount)
            return false;
 
        for(Uint32 i=0; i < InputAttachmentCount; ++i)
        {
            if (pInputAttachments[i] != RHS.pInputAttachments[i])
                return false;
        }
 
        for(Uint32 i=0; i < RenderTargetAttachmentCount; ++i)
        {
            if (pRenderTargetAttachments[i] != RHS.pRenderTargetAttachments[i])
                return false;
        }
 
        if ((pResolveAttachments == nullptr && RHS.pResolveAttachments != nullptr) ||
            (pResolveAttachments != nullptr && RHS.pResolveAttachments == nullptr))
            return false;
 
        if (pResolveAttachments != nullptr && RHS.pResolveAttachments != nullptr)
        {
            for(Uint32 i=0; i < RenderTargetAttachmentCount; ++i)
            {
                if (pResolveAttachments[i] != RHS.pResolveAttachments[i])
                    return false;
            }
        }
 
        if ((pDepthStencilAttachment == nullptr && RHS.pDepthStencilAttachment != nullptr) ||
            (pDepthStencilAttachment != nullptr && RHS.pDepthStencilAttachment == nullptr))
            return false;
 
        if (pDepthStencilAttachment != nullptr && RHS.pDepthStencilAttachment != nullptr)
        {
            if (*pDepthStencilAttachment != *RHS.pDepthStencilAttachment)
                return false;
        }
 
        if ((pPreserveAttachments == nullptr && RHS.pPreserveAttachments != nullptr) ||
            (pPreserveAttachments != nullptr && RHS.pPreserveAttachments == nullptr))
            return false;
 
        if (pPreserveAttachments != nullptr && RHS.pPreserveAttachments != nullptr)
        {
            for(Uint32 i=0; i < PreserveAttachmentCount; ++i)
            {
                if (pPreserveAttachments[i] != RHS.pPreserveAttachments[i])
                    return false;
            }
        }
 
        return true;
    }
#endif
};
typedef struct SubpassDesc SubpassDesc;
 
 
#define SUBPASS_EXTERNAL (~0U)
 
struct SubpassDependencyDesc
{
    Uint32                SrcSubpass    DEFAULT_INITIALIZER(0);
 
    Uint32                DstSubpass    DEFAULT_INITIALIZER(0);
 
    PIPELINE_STAGE_FLAGS  SrcStageMask  DEFAULT_INITIALIZER(PIPELINE_STAGE_FLAG_UNDEFINED);
 
    PIPELINE_STAGE_FLAGS  DstStageMask  DEFAULT_INITIALIZER(PIPELINE_STAGE_FLAG_UNDEFINED);
 
    ACCESS_FLAGS          SrcAccessMask DEFAULT_INITIALIZER(ACCESS_FLAG_NONE);
 
    ACCESS_FLAGS          DstAccessMask DEFAULT_INITIALIZER(ACCESS_FLAG_NONE);
 
#if DILIGENT_CPP_INTERFACE
 
    bool operator == (const SubpassDependencyDesc& RHS) const
    {
        return  SrcSubpass    == RHS.SrcSubpass    &&
                DstSubpass    == RHS.DstSubpass    &&
                SrcStageMask  == RHS.SrcStageMask  &&
                DstStageMask  == RHS.DstStageMask  &&
                SrcAccessMask == RHS.SrcAccessMask &&
                DstAccessMask == RHS.DstAccessMask;
    }
 
    bool operator != (const SubpassDependencyDesc& RHS) const
    {
        return !(*this == RHS);
    }
#endif
};
typedef struct SubpassDependencyDesc SubpassDependencyDesc;
 
struct RenderPassDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    Uint32                           AttachmentCount    DEFAULT_INITIALIZER(0);
 
    const RenderPassAttachmentDesc*  pAttachments       DEFAULT_INITIALIZER(nullptr);
 
    Uint32                           SubpassCount       DEFAULT_INITIALIZER(0);
 
    const SubpassDesc*               pSubpasses         DEFAULT_INITIALIZER(nullptr);
 
    Uint32                           DependencyCount    DEFAULT_INITIALIZER(0);
 
    const SubpassDependencyDesc*     pDependencies      DEFAULT_INITIALIZER(nullptr);
};
typedef struct RenderPassDesc RenderPassDesc;
 
 
#if DILIGENT_CPP_INTERFACE
 
 
class IRenderPass : public IDeviceObject
{
public:
    virtual const RenderPassDesc& DILIGENT_CALL_TYPE GetDesc() const override = 0;
};
 
#else
 
struct IRenderPass;
 
//  C requires that a struct or union has at least one member
//struct IRenderPassMethods
//{
//};
 
struct IRenderPassVtbl
{
    struct IObjectMethods       Object;
    struct IDeviceObjectMethods DeviceObject;
    //struct IRenderPassMethods  RenderPass;
};
 
typedef struct IRenderPass
{
    struct IRenderPassVtbl* pVtbl;
} IRenderPass;
 
#endif
 
DILIGENT_END_NAMESPACE // namespace Diligent