1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/*
* Copyright 2019-2021 Diligent Graphics LLC
* Copyright 2015-2019 Egor Yusov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* In no event and under no legal theory, whether in tort (including negligence),
* contract, or otherwise, unless required by applicable law (such as deliberate
* and grossly negligent acts) or agreed to in writing, shall any Contributor be
* liable for any damages, including any direct, indirect, special, incidental,
* or consequential damages of any character arising as a result of this License or
* out of the use or inability to use the software (including but not limited to damages
* for loss of goodwill, work stoppage, computer failure or malfunction, or any and
* all other commercial damages or losses), even if such Contributor has been advised
* of the possibility of such damages.
*/
#pragma once
#include <vector>
#include <deque>
#include "../../GraphicsEngine/interface/RenderDevice.h"
#include "../../GraphicsEngine/interface/DeviceContext.h"
#include "../../GraphicsEngine/interface/Query.h"
#include "../../../Common/interface/RefCntAutoPtr.hpp"
namespace Diligent
{
/// Helper class to manage scoped queries.
/// One scoped query instance must be used once per frame.
class ScopedQueryHelper
{
public:
ScopedQueryHelper(IRenderDevice* pDevice,
const QueryDesc& queryDesc,
Uint32 NumQueriesToReserve,
Uint32 ExpectedQueryLimit = 5);
// clang-format off
ScopedQueryHelper (const ScopedQueryHelper&) = delete;
ScopedQueryHelper& operator=(const ScopedQueryHelper&) = delete;
ScopedQueryHelper (ScopedQueryHelper&&) = default;
ScopedQueryHelper& operator=(ScopedQueryHelper&&) = delete;
// clang-format on
/// Begins a query.
/// \param [in] pCtx - Context to record begin query command
///
/// \remarks There must be exaclty one matching Begin() for every End() call, otherwise
/// the behavior is undefined.
void Begin(IDeviceContext* pCtx);
/// Ends a query and returns the query data, if it is available.
/// \param [in] pCtx - Context to record end query command.
/// \param [out] pData - Pointer to the buffer that will receive query data.
/// \param [in] DataSize - Buffer data size.
/// \return true if the data from the oldest query is available, and false otherwise.
///
/// \remarks There must be exaclty one matching End() for every Begin() call, otherwise
/// the behavior is undefined.
bool End(IDeviceContext* pCtx, void* pData, Uint32 DataSize);
private:
RefCntAutoPtr<IRenderDevice> m_pDevice;
const QueryDesc m_QueryDesc;
const Uint32 m_ExpectedQueryLimit;
std::deque<RefCntAutoPtr<IQuery>> m_PendingQueries;
std::vector<RefCntAutoPtr<IQuery>> m_AvailableQueries;
};
} // namespace Diligent
|