Diligent Engine  v.2.4.g
DeviceContextD3D12.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/DeviceContext.h"
34 #include "CommandQueueD3D12.h"
35 
37 
38 // {DDE9E3AB-5109-4026-92B7-F5E7EC83E21E}
39 static const INTERFACE_ID IID_DeviceContextD3D12 =
40  {0xdde9e3ab, 0x5109, 0x4026, {0x92, 0xb7, 0xf5, 0xe7, 0xec, 0x83, 0xe2, 0x1e}};
41 
42 #define DILIGENT_INTERFACE_NAME IDeviceContextD3D12
43 #include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
44 
45 #define IDeviceContextD3D12InclusiveMethods \
46  IDeviceContextInclusiveMethods; \
47  IDeviceContextD3D12Methods DeviceContextD3D12
48 
49 // clang-format off
50 
53 {
55 
58  VIRTUAL void METHOD(TransitionTextureState)(THIS_
59  ITexture* pTexture,
60  D3D12_RESOURCE_STATES State) PURE;
61 
63 
66  VIRTUAL void METHOD(TransitionBufferState)(THIS_
67  IBuffer* pBuffer,
68  D3D12_RESOURCE_STATES State) PURE;
69 
71 
87  VIRTUAL ID3D12GraphicsCommandList* METHOD(GetD3D12CommandList)(THIS) PURE;
88 
90 
105  VIRTUAL ICommandQueueD3D12* METHOD(LockCommandQueue)(THIS) PURE;
106 
108  VIRTUAL void METHOD(UnlockCommandQueue)(THIS) PURE;
109 };
111 
112 #include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
113 
114 #if DILIGENT_C_INTERFACE
115 
116 // clang-format off
117 
118 # define IDeviceContextD3D12_TransitionTextureState(This, ...) CALL_IFACE_METHOD(DeviceContextD3D12, TransitionTextureState,This, __VA_ARGS__)
119 # define IDeviceContextD3D12_TransitionBufferState(This, ...) CALL_IFACE_METHOD(DeviceContextD3D12, TransitionBufferState, This, __VA_ARGS__)
120 # define IDeviceContextD3D12_GetD3D12CommandList(This) CALL_IFACE_METHOD(DeviceContextD3D12, GetD3D12CommandList, This)
121 # define IDeviceContextD3D12_LockCommandQueue(This) CALL_IFACE_METHOD(DeviceContextD3D12, LockCommandQueue, This)
122 # define IDeviceContextD3D12_UnlockCommandQueue(This) CALL_IFACE_METHOD(DeviceContextD3D12, UnlockCommandQueue, This)
123 
124 // clang-format on
125 
126 #endif
127 
128 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_BEGIN_INTERFACE
#define DILIGENT_BEGIN_INTERFACE(Name, Base)
Definition: CommonDefinitions.h:97
Diligent::IDeviceContextD3D12
Exposes Direct3D12-specific functionality of a device context.
Definition: DeviceContextD3D12.h:52
THIS
#define THIS
Definition: DefineInterfaceHelperMacros.h:81
Diligent::IBuffer
Buffer interface.
Definition: Buffer.h:187
CommandQueueD3D12.h
PURE
#define PURE
Definition: DefineInterfaceHelperMacros.h:85
Diligent::ICommandQueueD3D12
Command queue interface.
Definition: CommandQueueD3D12.h:51
DILIGENT_END_NAMESPACE
#define DILIGENT_END_NAMESPACE
Definition: CommonDefinitions.h:86
METHOD
#define METHOD(Name)
Definition: DefineInterfaceHelperMacros.h:87
Diligent::IDeviceContext
Device context interface.
Definition: DeviceContext.h:1460
DILIGENT_BEGIN_NAMESPACE
#define DILIGENT_BEGIN_NAMESPACE(Name)
Definition: CommonDefinitions.h:82
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