1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
* 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
/// \file
/// Implementation of the Diligent::FramebufferBase template class
#include "Framebuffer.h"
#include "DeviceObjectBase.hpp"
#include "RenderDeviceBase.hpp"
#include "TextureView.h"
#include "GraphicsAccessories.hpp"
namespace Diligent
{
void ValidateFramebufferDesc(const FramebufferDesc& Desc) noexcept(false);
/// Template class implementing base functionality of the framebuffer object.
/// \tparam EngineImplTraits - Engine implementation type traits.
template <typename EngineImplTraits>
class FramebufferBase : public DeviceObjectBase<typename EngineImplTraits::FramebufferInterface, typename EngineImplTraits::RenderDeviceImplType, FramebufferDesc>
{
public:
// Base interface that this class inherits (e.g. IFramebufferVk).
using BaseInterface = typename EngineImplTraits::FramebufferInterface;
// Render device implementation type (RenderDeviceD3D12Impl, RenderDeviceVkImpl, etc.).
using RenderDeviceImplType = typename EngineImplTraits::RenderDeviceImplType;
using TDeviceObjectBase = DeviceObjectBase<BaseInterface, RenderDeviceImplType, FramebufferDesc>;
/// \param pRefCounters - Reference counters object that controls the lifetime of this framebuffer pass.
/// \param pDevice - Pointer to the device.
/// \param Desc - Framebuffer description.
/// \param bIsDeviceInternal - Flag indicating if the Framebuffer is an internal device object and
/// must not keep a strong reference to the device.
FramebufferBase(IReferenceCounters* pRefCounters,
RenderDeviceImplType* pDevice,
const FramebufferDesc& Desc,
bool bIsDeviceInternal = false) :
TDeviceObjectBase{pRefCounters, pDevice, Desc, bIsDeviceInternal},
m_pRenderPass{Desc.pRenderPass}
{
ValidateFramebufferDesc(this->m_Desc);
if (this->m_Desc.Width == 0 || this->m_Desc.Height == 0 || this->m_Desc.NumArraySlices == 0)
{
for (Uint32 i = 0; i < this->m_Desc.AttachmentCount; ++i)
{
auto* const pAttachment = Desc.ppAttachments[i];
if (pAttachment == nullptr)
continue;
const auto& ViewDesc = pAttachment->GetDesc();
const auto& TexDesc = pAttachment->GetTexture()->GetDesc();
auto MipLevelProps = GetMipLevelProperties(TexDesc, ViewDesc.MostDetailedMip);
if (this->m_Desc.Width == 0)
this->m_Desc.Width = MipLevelProps.LogicalWidth;
if (this->m_Desc.Height == 0)
this->m_Desc.Height = MipLevelProps.LogicalHeight;
if (this->m_Desc.NumArraySlices == 0)
this->m_Desc.NumArraySlices = ViewDesc.NumArraySlices;
}
}
// It is legal for a subpass to use no color or depth/stencil attachments, either because it has no attachment
// references or because all of them are VK_ATTACHMENT_UNUSED. This kind of subpass can use shader side effects
// such as image stores and atomics to produce an output. In this case, the subpass continues to use the width,
// height, and layers of the framebuffer to define the dimensions of the rendering area.
if (this->m_Desc.Width == 0)
LOG_ERROR_AND_THROW("The framebuffer width is zero and can't be automatically determined as there are no non-null attachments");
if (this->m_Desc.Height == 0)
LOG_ERROR_AND_THROW("The framebuffer height is zero and can't be automatically determined as there are no non-null attachments");
if (this->m_Desc.NumArraySlices == 0)
LOG_ERROR_AND_THROW("The framebuffer array slice count is zero and can't be automatically determined as there are no non-null attachments");
if (this->m_Desc.AttachmentCount > 0)
{
m_ppAttachments =
ALLOCATE(GetRawAllocator(), "Memory for framebuffer attachment array", ITextureView*, this->m_Desc.AttachmentCount);
this->m_Desc.ppAttachments = m_ppAttachments;
for (Uint32 i = 0; i < this->m_Desc.AttachmentCount; ++i)
{
if (Desc.ppAttachments[i] == nullptr)
continue;
m_ppAttachments[i] = Desc.ppAttachments[i];
m_ppAttachments[i]->AddRef();
}
}
Desc.pRenderPass->AddRef();
}
~FramebufferBase()
{
if (this->m_Desc.AttachmentCount > 0)
{
VERIFY_EXPR(m_ppAttachments != nullptr);
for (Uint32 i = 0; i < this->m_Desc.AttachmentCount; ++i)
{
m_ppAttachments[i]->Release();
}
GetRawAllocator().Free(m_ppAttachments);
}
this->m_Desc.pRenderPass->Release();
}
IMPLEMENT_QUERY_INTERFACE_IN_PLACE(IID_Framebuffer, TDeviceObjectBase)
private:
RefCntAutoPtr<IRenderPass> m_pRenderPass;
ITextureView** m_ppAttachments = nullptr;
};
} // namespace Diligent
|
