Diligent Engine  v.2.4.g
CommandQueueD3D12Impl.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 
32 
33 #include <mutex>
34 #include <atomic>
35 
36 #include "CommandQueueD3D12.h"
37 #include "ObjectBase.hpp"
38 
39 namespace Diligent
40 {
41 
43 class CommandQueueD3D12Impl final : public ObjectBase<ICommandQueueD3D12>
44 {
45 public:
47 
48  CommandQueueD3D12Impl(IReferenceCounters* pRefCounters, ID3D12CommandQueue* pd3d12NativeCmdQueue, ID3D12Fence* pd3d12Fence);
50 
51  IMPLEMENT_QUERY_INTERFACE_IN_PLACE(IID_CommandQueueD3D12, TBase)
52 
53  // Implementation of ICommandQueueD3D12::GetNextFenceValue().
54  virtual Uint64 DILIGENT_CALL_TYPE GetNextFenceValue() const override final { return m_NextFenceValue.load(); }
55 
56  // Implementation of ICommandQueueD3D12::Submit().
57  virtual Uint64 DILIGENT_CALL_TYPE Submit(Uint32 NumCommandLists,
58  ID3D12CommandList* const* ppCommandLists) override final;
59 
60  // Implementation of ICommandQueueD3D12::GetD3D12CommandQueue().
61  virtual ID3D12CommandQueue* DILIGENT_CALL_TYPE GetD3D12CommandQueue() override final { return m_pd3d12CmdQueue; }
62 
63  // Implementation of ICommandQueueD3D12::WaitForIdle().
64  virtual Uint64 DILIGENT_CALL_TYPE WaitForIdle() override final;
65 
66  // Implementation of ICommandQueueD3D12::GetCompletedFenceValue().
67  virtual Uint64 DILIGENT_CALL_TYPE GetCompletedFenceValue() override final;
68 
69  // Implementation of ICommandQueueD3D12::SignalFence().
70  virtual void DILIGENT_CALL_TYPE SignalFence(ID3D12Fence* pFence, Uint64 Value) override final;
71 
72 private:
73  // A value that will be signaled by the command queue next
74  std::atomic_uint64_t m_NextFenceValue{1};
75 
76  // Last fence value completed by the GPU
77  std::atomic_uint64_t m_LastCompletedFenceValue{0};
78 
79  std::mutex m_QueueMtx;
80  CComPtr<ID3D12CommandQueue> m_pd3d12CmdQueue;
81 
82  // The fence is signaled right after the command list has been
83  // submitted to the command queue for execution.
84  // All command lists with fence value less or equal to the signaled value
85  // are guaranteed to be finished by the GPU
86  CComPtr<ID3D12Fence> m_d3d12Fence;
87 
88  HANDLE m_WaitForGPUEventHandle = {};
89 };
90 
91 } // namespace Diligent
Diligent::CommandQueueD3D12Impl::WaitForIdle
virtual Uint64 WaitForIdle() override final
Definition: CommandQueueD3D12Impl.cpp:81
ObjectBase.hpp
Diligent::IReferenceCounters
Base interface for a reference counter object that stores the number of strong and weak references an...
Definition: ReferenceCounters.h:44
Diligent::CommandQueueD3D12Impl::CommandQueueD3D12Impl
CommandQueueD3D12Impl(IReferenceCounters *pRefCounters, ID3D12CommandQueue *pd3d12NativeCmdQueue, ID3D12Fence *pd3d12Fence)
Definition: CommandQueueD3D12Impl.cpp:34
Diligent::Uint64
uint64_t Uint64
64-bit unsigned integer
Definition: BasicTypes.h:50
Diligent::ObjectBase
Template class implementing base functionality for an object.
Definition: ObjectBase.hpp:66
CommandQueueD3D12.h
IMPLEMENT_QUERY_INTERFACE_IN_PLACE
#define IMPLEMENT_QUERY_INTERFACE_IN_PLACE(InterfaceID, ParentClassName)
Definition: ObjectBase.hpp:59
Diligent::CommandQueueD3D12Impl::SignalFence
virtual void SignalFence(ID3D12Fence *pFence, Uint64 Value) override final
Definition: CommandQueueD3D12Impl.cpp:112
DILIGENT_CALL_TYPE
#define DILIGENT_CALL_TYPE
Definition: CommonDefinitions.h:45
Diligent::Uint32
uint32_t Uint32
32-bit unsigned integer
Definition: BasicTypes.h:51
Diligent::CommandQueueD3D12Impl::~CommandQueueD3D12Impl
~CommandQueueD3D12Impl()
Definition: CommandQueueD3D12Impl.cpp:49
std
Definition: AdvancedMath.hpp:979
Diligent::CommandQueueD3D12Impl
Implementation of the Diligent::ICommandQueueD3D12 interface.
Definition: CommandQueueD3D12Impl.hpp:43
Diligent::CommandQueueD3D12Impl::GetCompletedFenceValue
virtual Uint64 GetCompletedFenceValue() override final
Definition: CommandQueueD3D12Impl.cpp:98
Diligent::CommandQueueD3D12Impl::GetNextFenceValue
virtual Uint64 GetNextFenceValue() const override final
Definition: CommandQueueD3D12Impl.hpp:54
Diligent::CommandQueueD3D12Impl::GetD3D12CommandQueue
virtual ID3D12CommandQueue * GetD3D12CommandQueue() override final
Definition: CommandQueueD3D12Impl.hpp:61
Diligent::CommandQueueD3D12Impl::Submit
virtual Uint64 Submit(Uint32 NumCommandLists, ID3D12CommandList *const *ppCommandLists) override final
Definition: CommandQueueD3D12Impl.cpp:54
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37