Diligent Engine  v.2.4.g
QueryD3D12Impl.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 <array>
34 
36 #include "QueryBase.hpp"
37 #include "QueryManagerD3D12.hpp"
38 
39 namespace Diligent
40 {
41 
42 // https://microsoft.github.io/DirectX-Specs/d3d/CountersAndQueries.html#queries
43 
45 class QueryD3D12Impl final : public QueryBase<EngineD3D12ImplTraits>
46 {
47 public:
49 
50  QueryD3D12Impl(IReferenceCounters* pRefCounters,
51  RenderDeviceD3D12Impl* pDevice,
52  const QueryDesc& Desc);
54 
56 
57 
58  virtual bool DILIGENT_CALL_TYPE GetData(void* pData, Uint32 DataSize, bool AutoInvalidate) override final;
59 
61  virtual ID3D12QueryHeap* DILIGENT_CALL_TYPE GetD3D12QueryHeap() override final;
62 
64  virtual Uint32 DILIGENT_CALL_TYPE GetQueryHeapIndex(Uint32 QueryId) const override final
65  {
66  VERIFY_EXPR(QueryId == 0 || m_Desc.Type == QUERY_TYPE_DURATION && QueryId == 1);
67  return m_QueryHeapIndex[QueryId];
68  }
69 
70  bool OnEndQuery(IDeviceContext* pContext);
71 
72 private:
73  std::array<Uint32, 2> m_QueryHeapIndex = {QueryManagerD3D12::InvalidIndex, QueryManagerD3D12::InvalidIndex};
74 
75  Uint64 m_QueryEndFenceValue = 0;
76 };
77 
78 } // namespace Diligent
Diligent::QueryD3D12Impl::~QueryD3D12Impl
~QueryD3D12Impl()
Definition: QueryD3D12Impl.cpp:62
Diligent::IReferenceCounters
Base interface for a reference counter object that stores the number of strong and weak references an...
Definition: ReferenceCounters.h:44
Diligent::QueryD3D12Impl::GetData
virtual bool GetData(void *pData, Uint32 DataSize, bool AutoInvalidate) override final
Implementation of IQuery::GetData().
Definition: QueryD3D12Impl.cpp:84
Diligent::QueryD3D12Impl::OnEndQuery
bool OnEndQuery(IDeviceContext *pContext)
Definition: QueryD3D12Impl.cpp:74
Diligent::QueryDesc
Query description.
Definition: Query.h:150
Diligent::Uint64
uint64_t Uint64
64-bit unsigned integer
Definition: BasicTypes.h:50
Diligent::DeviceObjectBase< EngineD3D12ImplTraits ::QueryInterface, EngineD3D12ImplTraits ::RenderDeviceImplType, QueryDesc >::m_Desc
QueryDesc m_Desc
Object description.
Definition: DeviceObjectBase.hpp:182
QueryBase.hpp
Diligent::QueryD3D12Impl::GetD3D12QueryHeap
virtual ID3D12QueryHeap * GetD3D12QueryHeap() override final
Implementation of IQueryD3D12::GetD3D12QueryHeap().
Definition: QueryD3D12Impl.cpp:200
QueryManagerD3D12.hpp
Diligent::QueryD3D12Impl::QueryD3D12Impl
QueryD3D12Impl(IReferenceCounters *pRefCounters, RenderDeviceD3D12Impl *pDevice, const QueryDesc &Desc)
Definition: QueryD3D12Impl.cpp:41
Diligent::QueryD3D12Impl::GetQueryHeapIndex
virtual Uint32 GetQueryHeapIndex(Uint32 QueryId) const override final
Implementation of IQueryD3D12::GetQueryHeapIndex().
Definition: QueryD3D12Impl.hpp:64
Diligent::QueryDesc::Type
enum QUERY_TYPE Type
Query type, see Diligent::QUERY_TYPE.
Definition: Query.h:153
Diligent::QueryManagerD3D12::InvalidIndex
static constexpr Uint32 InvalidIndex
Definition: QueryManagerD3D12.hpp:58
Diligent::RenderDeviceD3D12Impl
Render device implementation in Direct3D12 backend.
Definition: RenderDeviceD3D12Impl.hpp:70
IMPLEMENT_QUERY_INTERFACE_IN_PLACE
#define IMPLEMENT_QUERY_INTERFACE_IN_PLACE(InterfaceID, ParentClassName)
Definition: ObjectBase.hpp:59
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::QUERY_TYPE_DURATION
@ QUERY_TYPE_DURATION
Gets the number of high-frequency counter ticks between IDeviceContext::BeginQuery and IDeviceContext...
Definition: GraphicsTypes.h:1470
Diligent::QueryD3D12Impl
Query implementation in Direct3D12 backend.
Definition: QueryD3D12Impl.hpp:45
EngineD3D12ImplTraits.hpp
Diligent::IDeviceContext
Device context interface.
Definition: DeviceContext.h:1460
VERIFY_EXPR
#define VERIFY_EXPR(...)
Definition: DebugUtilities.hpp:79
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37
Diligent::QueryBase
Template class implementing base functionality of the query object.
Definition: QueryBase.hpp:45