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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* 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
/// Declaration of Diligent::ShaderVariableManagerVk and Diligent::ShaderVariableVkImpl classes
//
// * ShaderVariableManagerVk keeps the list of variables of specific types
// * Every ShaderVariableVkImpl references ResourceAttribs by index from PipelineResourceSignatureVkImpl
// * ShaderVariableManagerVk keeps reference to ShaderResourceCacheVk
// * ShaderVariableManagerVk is used by PipelineResourceSignatureVkImpl to manage static resources and by
// ShaderResourceBindingVkImpl to manage mutable and dynamic resources
//
// __________________________ __________________________________________________________________________
// | | | | | |
// .----| ShaderVariableManagerVk |-------------------------->| ShaderVariableVkImpl[0] | ShaderVariableVkImpl[1] | ... |
// | |__________________________| |___________________________|____________________________|_________________|
// | | \ |
// | m_pSignature m_ResIndex m_ResIndex
// | | \ |
// | ___________V_____________________ ______________________V_______________________V____________________________
// | | | m_pResourceAttribs | | | | |
// | | PipelineResourceSignatureVkImpl |------------------->| Resource[0] | Resource[1] | ... | Resource[s+m+d-1] |
// | |_________________________________| |__________________|________________|_______________|_____________________|
// | | |
// | | |
// | | (DescriptorSet, CacheOffset) / (DescriptorSet, CacheOffset)
// | \ /
// | __________________________ ________V___________________________________________________V_______
// | | | | |
// '--->| ShaderResourceCacheVk |-------------------------->| Resources |
// |__________________________| |____________________________________________________________________|
//
//
#include <memory>
#include "ShaderResourceVariableBase.hpp"
#include "ShaderResourceCacheVk.hpp"
#include "PipelineResourceAttribsVk.hpp"
namespace Diligent
{
class ShaderVariableVkImpl;
// sizeof(ShaderVariableManagerVk) == 40 (x64, msvc, Release)
class ShaderVariableManagerVk
{
public:
ShaderVariableManagerVk(IObject& Owner,
ShaderResourceCacheVk& ResourceCache) noexcept :
m_Owner{Owner},
m_ResourceCache{ResourceCache}
{}
void Initialize(const PipelineResourceSignatureVkImpl& Signature,
IMemoryAllocator& Allocator,
const SHADER_RESOURCE_VARIABLE_TYPE* AllowedVarTypes,
Uint32 NumAllowedTypes,
SHADER_TYPE ShaderType);
~ShaderVariableManagerVk();
void Destroy(IMemoryAllocator& Allocator);
ShaderVariableVkImpl* GetVariable(const Char* Name) const;
ShaderVariableVkImpl* GetVariable(Uint32 Index) const;
// Binds object pObj to resource with index ResIndex and array index ArrayIndex.
void BindResource(IDeviceObject* pObj,
Uint32 ArrayIndex,
Uint32 ResIndex);
bool IsBound(Uint32 ArrayIndex,
Uint32 ResIndex) const;
void BindResources(IResourceMapping* pResourceMapping, Uint32 Flags) const;
static size_t GetRequiredMemorySize(const PipelineResourceSignatureVkImpl& Signature,
const SHADER_RESOURCE_VARIABLE_TYPE* AllowedVarTypes,
Uint32 NumAllowedTypes,
SHADER_TYPE ShaderStages,
Uint32& NumVariables);
Uint32 GetVariableCount() const { return m_NumVariables; }
IObject& GetOwner() { return m_Owner; }
private:
friend ShaderVariableVkImpl;
friend ShaderVariableBase<ShaderVariableVkImpl, ShaderVariableManagerVk, IShaderResourceVariable>;
using ResourceAttribs = PipelineResourceAttribsVk;
Uint32 GetVariableIndex(const ShaderVariableVkImpl& Variable);
// These two methods can't be implemented in the header because they depend on PipelineResourceSignatureVkImpl
const PipelineResourceDesc& GetResourceDesc(Uint32 Index) const;
const ResourceAttribs& GetAttribs(Uint32 Index) const;
private:
PipelineResourceSignatureVkImpl const* m_pSignature = nullptr;
IObject& m_Owner;
// Variable mgr is owned by either Pipeline Resource Signature (in which case m_ResourceCache references
// static resource cache owned by the same PRS object), or by SRB object (in which case
// m_ResourceCache references the cache in the SRB). Thus the cache and the signature
// (which the variables reference) are guaranteed to be alive while the manager is alive.
ShaderResourceCacheVk& m_ResourceCache;
// Memory is allocated through the allocator provided by the resource signature. If allocation granularity > 1, fixed block
// memory allocator is used. This ensures that all resources from different shader resource bindings reside in
// continuous memory. If allocation granularity == 1, raw allocator is used.
ShaderVariableVkImpl* m_pVariables = nullptr;
Uint32 m_NumVariables = 0;
#ifdef DILIGENT_DEBUG
IMemoryAllocator* m_pDbgAllocator = nullptr;
#endif
};
// sizeof(ShaderVariableVkImpl) == 24 (x64)
class ShaderVariableVkImpl final : public ShaderVariableBase<ShaderVariableVkImpl, ShaderVariableManagerVk, IShaderResourceVariable>
{
public:
using TBase = ShaderVariableBase<ShaderVariableVkImpl, ShaderVariableManagerVk, IShaderResourceVariable>;
ShaderVariableVkImpl(ShaderVariableManagerVk& ParentManager,
Uint32 ResIndex) :
TBase{ParentManager, ResIndex}
{}
// clang-format off
ShaderVariableVkImpl (const ShaderVariableVkImpl&) = delete;
ShaderVariableVkImpl (ShaderVariableVkImpl&&) = delete;
ShaderVariableVkImpl& operator= (const ShaderVariableVkImpl&) = delete;
ShaderVariableVkImpl& operator= (ShaderVariableVkImpl&&) = delete;
// clang-format on
virtual bool DILIGENT_CALL_TYPE IsBound(Uint32 ArrayIndex) const override final
{
return m_ParentManager.IsBound(ArrayIndex, m_ResIndex);
}
void BindResource(IDeviceObject* pObj, Uint32 ArrayIndex) const
{
return m_ParentManager.BindResource(pObj, ArrayIndex, m_ResIndex);
}
};
} // namespace Diligent
|
