Diligent Engine  v.2.4.g
RenderDeviceVk.h
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 
32 
33 #include "../../GraphicsEngine/interface/RenderDevice.h"
34 
36 
37 // {AB8CF3A6-D959-41C1-AE00-A58AE9820E6A}
38 static const INTERFACE_ID IID_RenderDeviceVk =
39  {0xab8cf3a6, 0xd959, 0x41c1, {0xae, 0x0, 0xa5, 0x8a, 0xe9, 0x82, 0xe, 0x6a}};
40 
41 #define DILIGENT_INTERFACE_NAME IRenderDeviceVk
42 #include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
43 
44 #define IRenderDeviceVkInclusiveMethods \
45  IRenderDeviceInclusiveMethods; \
46  IRenderDeviceVkMethods RenderDeviceVk
47 
48 // clang-format off
49 
52 {
54  VIRTUAL VkDevice METHOD(GetVkDevice)(THIS) PURE;
55 
57  VIRTUAL VkPhysicalDevice METHOD(GetVkPhysicalDevice)(THIS) PURE;
58 
60  VIRTUAL VkInstance METHOD(GetVkInstance)(THIS) PURE;
61 
63 
65  VIRTUAL Uint32 METHOD(GetVkVersion)(THIS) PURE;
66 
68  VIRTUAL Uint64 METHOD(GetNextFenceValue)(THIS_
69  Uint32 QueueIndex) PURE;
70 
72  VIRTUAL Uint64 METHOD(GetCompletedFenceValue)(THIS_
73  Uint32 QueueIndex) PURE;
74 
77  VIRTUAL Bool METHOD(IsFenceSignaled)(THIS_
78  Uint32 QueueIndex,
79  Uint64 FenceValue) PURE;
80 
82 
95  VIRTUAL void METHOD(CreateTextureFromVulkanImage)(THIS_
96  VkImage vkImage,
97  const TextureDesc REF TexDesc,
98  RESOURCE_STATE InitialState,
99  ITexture** ppTexture) PURE;
100 
102 
115  VIRTUAL void METHOD(CreateBufferFromVulkanResource)(THIS_
116  VkBuffer vkBuffer,
117  const BufferDesc REF BuffDesc,
118  RESOURCE_STATE InitialState,
119  IBuffer** ppBuffer) PURE;
120 
122 
134  VIRTUAL void METHOD(CreateBLASFromVulkanResource)(THIS_
135  VkAccelerationStructureKHR vkBLAS,
136  const BottomLevelASDesc REF Desc,
137  RESOURCE_STATE InitialState,
138  IBottomLevelAS** ppBLAS) PURE;
139 
141 
153  VIRTUAL void METHOD(CreateTLASFromVulkanResource)(THIS_
154  VkAccelerationStructureKHR vkTLAS,
155  const TopLevelASDesc REF Desc,
156  RESOURCE_STATE InitialState,
157  ITopLevelAS** ppTLAS) PURE;
158 };
160 
161 #include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
162 
163 #if DILIGENT_C_INTERFACE
164 
165 // clang-format off
166 
167 # define IRenderDeviceVk_GetVkDevice(This) CALL_IFACE_METHOD(RenderDeviceVk, GetVkDevice, This)
168 # define IRenderDeviceVk_GetVkPhysicalDevice(This) CALL_IFACE_METHOD(RenderDeviceVk, GetVkPhysicalDevice, This)
169 # define IRenderDeviceVk_GetVkInstance(This) CALL_IFACE_METHOD(RenderDeviceVk, GetVkInstance, This)
170 # define IRenderDeviceVk_GetNextFenceValue(This, ...) CALL_IFACE_METHOD(RenderDeviceVk, GetNextFenceValue, This, __VA_ARGS__)
171 # define IRenderDeviceVk_GetCompletedFenceValue(This, ...) CALL_IFACE_METHOD(RenderDeviceVk, GetCompletedFenceValue, This, __VA_ARGS__)
172 # define IRenderDeviceVk_IsFenceSignaled(This, ...) CALL_IFACE_METHOD(RenderDeviceVk, IsFenceSignaled, This, __VA_ARGS__)
173 # define IRenderDeviceVk_CreateTextureFromVulkanImage(This, ...) CALL_IFACE_METHOD(RenderDeviceVk, CreateTextureFromVulkanImage, This, __VA_ARGS__)
174 # define IRenderDeviceVk_CreateBufferFromVulkanResource(This, ...) CALL_IFACE_METHOD(RenderDeviceVk, CreateBufferFromVulkanResource, This, __VA_ARGS__)
175 # define IRenderDeviceVk_CreateBLASFromVulkanResource(This, ...) CALL_IFACE_METHOD(RenderDeviceVk, CreateBLASFromVulkanResource, This, __VA_ARGS__)
176 # define IRenderDeviceVk_CreateTLASFromVulkanResource(This, ...) CALL_IFACE_METHOD(RenderDeviceVk, CreateTLASFromVulkanResource, This, __VA_ARGS__)
177 
178 // clang-format on
179 
180 #endif
181 
182 DILIGENT_END_NAMESPACE // namespace Diligent
DILIGENT_END_INTERFACE
#define DILIGENT_END_INTERFACE
Definition: DefineInterfaceHelperMacros.h:88
Diligent::INTERFACE_ID
struct INTERFACE_ID INTERFACE_ID
Definition: InterfaceID.h:54
VIRTUAL
#define VIRTUAL
Definition: DefineInterfaceHelperMacros.h:83
Diligent::TopLevelASDesc
Top-level AS description.
Definition: TopLevelAS.h:49
DILIGENT_BEGIN_INTERFACE
#define DILIGENT_BEGIN_INTERFACE(Name, Base)
Definition: CommonDefinitions.h:97
Diligent::Uint64
uint64_t Uint64
64-bit unsigned integer
Definition: BasicTypes.h:50
Diligent::ITopLevelAS
Top-level AS interface.
Definition: TopLevelAS.h:151
Diligent::IRenderDeviceVk
Exposes Vulkan-specific functionality of a render device.
Definition: RenderDeviceVk.h:51
THIS
#define THIS
Definition: DefineInterfaceHelperMacros.h:81
Diligent::IBuffer
Buffer interface.
Definition: Buffer.h:187
PURE
#define PURE
Definition: DefineInterfaceHelperMacros.h:85
Diligent::IRenderDevice
Render device interface.
Definition: RenderDevice.h:75
Diligent::TextureDesc
Texture description.
Definition: Texture.h:47
DILIGENT_END_NAMESPACE
#define DILIGENT_END_NAMESPACE
Definition: CommonDefinitions.h:86
Diligent::Uint32
uint32_t Uint32
32-bit unsigned integer
Definition: BasicTypes.h:51
Diligent::Bool
bool Bool
Boolean.
Definition: BasicTypes.h:59
Diligent::BufferDesc
Buffer description.
Definition: Buffer.h:74
REF
#define REF
Definition: DefineGlobalFuncHelperMacros.h:39
METHOD
#define METHOD(Name)
Definition: DefineInterfaceHelperMacros.h:87
DILIGENT_BEGIN_NAMESPACE
#define DILIGENT_BEGIN_NAMESPACE(Name)
Definition: CommonDefinitions.h:82
Diligent::IBottomLevelAS
Bottom-level AS interface.
Definition: BottomLevelAS.h:207
Diligent::RESOURCE_STATE
RESOURCE_STATE
Resource usage state.
Definition: GraphicsTypes.h:2814
Diligent::BottomLevelASDesc
Bottom-level AS description.
Definition: BottomLevelAS.h:145
Diligent::ITexture
Texture inteface.
Definition: Texture.h:273
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37
THIS_
#define THIS_
Definition: DefineInterfaceHelperMacros.h:82