Diligent Engine  v.2.4.g
BufferD3D12.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/Buffer.h"
34 #include "../../GraphicsEngine/interface/DeviceContext.h"
35 
37 
38 // {3E9B15ED-A289-48DC-8214-C6E3E6177378}
39 static const INTERFACE_ID IID_BufferD3D12 =
40  {0x3e9b15ed, 0xa289, 0x48dc, {0x82, 0x14, 0xc6, 0xe3, 0xe6, 0x17, 0x73, 0x78}};
41 
42 #define DILIGENT_INTERFACE_NAME IBufferD3D12
43 #include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
44 
45 #define IBufferD3D12InclusiveMethods \
46  IBufferInclusiveMethods; \
47  IBufferD3D12Methods BufferD3D12
48 
49 // clang-format off
50 
53 {
55 
63  VIRTUAL ID3D12Resource* METHOD(GetD3D12Buffer)(THIS_
64  Uint64 REF DataStartByteOffset,
65  IDeviceContext* pContext) PURE;
66 
68 
70  VIRTUAL void METHOD(SetD3D12ResourceState)(THIS_
71  D3D12_RESOURCE_STATES state) PURE;
72 
76  VIRTUAL D3D12_RESOURCE_STATES METHOD(GetD3D12ResourceState)(THIS) CONST PURE;
77 };
79 
80 #include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
81 
82 #if DILIGENT_C_INTERFACE
83 
84 # define IBufferD3D12_GetD3D12Buffer(This, ...) CALL_IFACE_METHOD(BufferD3D12, GetD3D12Buffer, This, __VA_ARGS__)
85 # define IBufferD3D12_SetD3D12ResourceState(This, ...) CALL_IFACE_METHOD(BufferD3D12, SetD3D12ResourceState, This, __VA_ARGS__)
86 # define IBufferD3D12_GetD3D12ResourceState(This) CALL_IFACE_METHOD(BufferD3D12, GetD3D12ResourceState, This)
87 
88 #endif
89 
90 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::Uint64
uint64_t Uint64
64-bit unsigned integer
Definition: BasicTypes.h:50
THIS
#define THIS
Definition: DefineInterfaceHelperMacros.h:81
Diligent::IBuffer
Buffer interface.
Definition: Buffer.h:187
PURE
#define PURE
Definition: DefineInterfaceHelperMacros.h:85
DILIGENT_END_NAMESPACE
#define DILIGENT_END_NAMESPACE
Definition: CommonDefinitions.h:86
CONST
#define CONST
Definition: DefineInterfaceHelperMacros.h:84
REF
#define REF
Definition: DefineGlobalFuncHelperMacros.h:39
METHOD
#define METHOD(Name)
Definition: DefineInterfaceHelperMacros.h:87
Diligent::IBufferD3D12
Exposes Direct3D12-specific functionality of a buffer object.
Definition: BufferD3D12.h:52
Diligent::IDeviceContext
Device context interface.
Definition: DeviceContext.h:1460
DILIGENT_BEGIN_NAMESPACE
#define DILIGENT_BEGIN_NAMESPACE(Name)
Definition: CommonDefinitions.h:82
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37
THIS_
#define THIS_
Definition: DefineInterfaceHelperMacros.h:82