Diligent Engine  v.2.4.g
ShaderVariableD3D.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 2019-2021 Diligent Graphics LLC
3  * Copyright 2015-2019 Egor Yusov
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * In no event and under no legal theory, whether in tort (including negligence),
18  * contract, or otherwise, unless required by applicable law (such as deliberate
19  * and grossly negligent acts) or agreed to in writing, shall any Contributor be
20  * liable for any damages, including any direct, indirect, special, incidental,
21  * or consequential damages of any character arising as a result of this License or
22  * out of the use or inability to use the software (including but not limited to damages
23  * for loss of goodwill, work stoppage, computer failure or malfunction, or any and
24  * all other commercial damages or losses), even if such Contributor has been advised
25  * of the possibility of such damages.
26  */
27 
28 #pragma once
29 
30 
32 
33 namespace Diligent
34 {
35 
36 template <typename BufferViewImplType>
37 bool VerifyBufferViewModeD3D(BufferViewImplType* pViewD3D, const D3DShaderResourceAttribs& Attribs, const char* ShaderName)
38 {
39  if (pViewD3D == nullptr)
40  return true;
41 
42  const auto& ViewDesc = pViewD3D->GetDesc();
43  const auto& BuffDesc = pViewD3D->GetBuffer()->GetDesc();
44 
45  auto LogBufferBindingError = [&](const char* Msg) //
46  {
47  LOG_ERROR_MESSAGE("Buffer view '", ViewDesc.Name, "' of buffer '", BuffDesc.Name,
48  "' bound to shader variable '", Attribs.Name, "' in shader '", ShaderName, "' is invalid: ", Msg);
49  };
50 
51  switch (Attribs.GetInputType())
52  {
53  case D3D_SIT_TEXTURE:
54  case D3D_SIT_UAV_RWTYPED:
55  if (BuffDesc.Mode != BUFFER_MODE_FORMATTED || ViewDesc.Format.ValueType == VT_UNDEFINED)
56  {
57  LogBufferBindingError("formatted buffer view is expected.");
58  return false;
59  }
60  break;
61 
62  case D3D_SIT_STRUCTURED:
63  case D3D_SIT_UAV_RWSTRUCTURED:
64  if (BuffDesc.Mode != BUFFER_MODE_STRUCTURED)
65  {
66  LogBufferBindingError("structured buffer view is expected.");
67  return false;
68  }
69  break;
70 
71  case D3D_SIT_BYTEADDRESS:
72  case D3D_SIT_UAV_RWBYTEADDRESS:
73  if (BuffDesc.Mode != BUFFER_MODE_RAW)
74  {
75  LogBufferBindingError("raw buffer view is expected.");
76  return false;
77  }
78  break;
79  }
80 
81  return true;
82 }
83 
84 } // namespace Diligent
LOG_ERROR_MESSAGE
#define LOG_ERROR_MESSAGE(...)
Definition: Errors.hpp:122
Diligent::VerifyBufferViewModeD3D
bool VerifyBufferViewModeD3D(BufferViewImplType *pViewD3D, const D3DShaderResourceAttribs &Attribs, const char *ShaderName)
Definition: ShaderVariableD3D.hpp:37
Diligent::VT_UNDEFINED
@ VT_UNDEFINED
Undefined type.
Definition: GraphicsTypes.h:51
Diligent::D3DShaderResourceAttribs::Name
const char *const Name
Definition: ShaderResources.hpp:84
Diligent::BUFFER_MODE_FORMATTED
@ BUFFER_MODE_FORMATTED
Formated buffer. Access to the buffer will use format conversion operations. In this mode,...
Definition: Buffer.h:56
Diligent::D3DShaderResourceAttribs::GetInputType
D3D_SHADER_INPUT_TYPE GetInputType() const
Definition: ShaderResources.hpp:192
Diligent::D3DShaderResourceAttribs
Definition: ShaderResources.hpp:80
Diligent::BUFFER_MODE_STRUCTURED
@ BUFFER_MODE_STRUCTURED
Structured buffer. In this mode, ElementByteStride member of BufferDesc defines the structure stride.
Definition: Buffer.h:60
Diligent::BUFFER_MODE_RAW
@ BUFFER_MODE_RAW
Raw buffer. In this mode, the buffer is accessed as raw bytes. Formatted views of a raw buffer can al...
Definition: Buffer.h:67
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37