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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/*
* 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
/// \file
/// Defines Diligent::IQuery interface and related data structures
#include "DeviceObject.h"
#include "GraphicsTypes.h"
DILIGENT_BEGIN_NAMESPACE(Diligent)
// {70F2A88A-F8BE-4901-8F05-2F72FA695BA0}
static const INTERFACE_ID IID_Query =
{0x70f2a88a, 0xf8be, 0x4901, {0x8f, 0x5, 0x2f, 0x72, 0xfa, 0x69, 0x5b, 0xa0}};
/// Occlusion query data.
/// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_OCCLUSION query type.
struct QueryDataOcclusion
{
/// Query type - must be Diligent::QUERY_TYPE_OCCLUSION
const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_OCCLUSION);
/// The number of samples that passed the depth and stencil tests in between
/// IDeviceContext::BeginQuery and IDeviceContext::EndQuery.
Uint64 NumSamples DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataOcclusion QueryDataOcclusion;
/// Binary occlusion query data.
/// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_BINARY_OCCLUSION query type.
struct QueryDataBinaryOcclusion
{
/// Query type - must be Diligent::QUERY_TYPE_BINARY_OCCLUSION
const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_BINARY_OCCLUSION);
/// Indicates if at least one sample passed depth and stencil testing in between
/// IDeviceContext::BeginQuery and IDeviceContext::EndQuery.
bool AnySamplePassed DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataBinaryOcclusion QueryDataBinaryOcclusion;
/// Timestamp query data.
/// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_TIMESTAMP query type.
struct QueryDataTimestamp
{
/// Query type - must be Diligent::QUERY_TYPE_TIMESTAMP
const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_TIMESTAMP);
/// The value of a high-frequency counter.
Uint64 Counter DEFAULT_INITIALIZER(0);
/// The counter frequency, in Hz (ticks/second). If there was an error
/// while getting the timestamp, this value will be 0.
Uint64 Frequency DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataTimestamp QueryDataTimestamp;
/// Pipeline statistics query data.
/// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_PIPELINE_STATISTICS query type.
///
/// \warning In OpenGL backend the only field that will be populated is ClippingInvocations.
struct QueryDataPipelineStatistics
{
/// Query type - must be Diligent::QUERY_TYPE_PIPELINE_STATISTICS
const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_PIPELINE_STATISTICS);
/// Number of vertices processed by the input assembler stage.
Uint64 InputVertices DEFAULT_INITIALIZER(0);
/// Number of primitives processed by the input assembler stage.
Uint64 InputPrimitives DEFAULT_INITIALIZER(0);
/// Number of primitives output by a geometry shader.
Uint64 GSPrimitives DEFAULT_INITIALIZER(0);
/// Number of primitives that were sent to the clipping stage.
Uint64 ClippingInvocations DEFAULT_INITIALIZER(0);
/// Number of primitives that were output by the clipping stage and were rendered.
/// This may be larger or smaller than ClippingInvocations because after a primitive is
/// clipped sometimes it is either broken up into more than one primitive or completely culled.
Uint64 ClippingPrimitives DEFAULT_INITIALIZER(0);
/// Number of times a vertex shader was invoked.
Uint64 VSInvocations DEFAULT_INITIALIZER(0);
/// Number of times a geometry shader was invoked.
Uint64 GSInvocations DEFAULT_INITIALIZER(0);
/// Number of times a pixel shader shader was invoked.
Uint64 PSInvocations DEFAULT_INITIALIZER(0);
/// Number of times a hull shader shader was invoked.
Uint64 HSInvocations DEFAULT_INITIALIZER(0);
/// Number of times a domain shader shader was invoked.
Uint64 DSInvocations DEFAULT_INITIALIZER(0);
/// Number of times a compute shader was invoked.
Uint64 CSInvocations DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataPipelineStatistics QueryDataPipelineStatistics;
/// Duration query data.
/// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_DURATION query type.
struct QueryDataDuration
{
/// Query type - must be Diligent::QUERY_TYPE_DURATION
const enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_DURATION);
/// The number of high-frequency counter ticks between
/// BeginQuery and EndQuery calls.
Uint64 Duration DEFAULT_INITIALIZER(0);
/// The counter frequency, in Hz (ticks/second). If there was an error
/// while getting the timestamp, this value will be 0.
Uint64 Frequency DEFAULT_INITIALIZER(0);
};
typedef struct QueryDataDuration QueryDataDuration;
// clang-format off
/// Query description.
struct QueryDesc DILIGENT_DERIVE(DeviceObjectAttribs)
/// Query type, see Diligent::QUERY_TYPE.
enum QUERY_TYPE Type DEFAULT_INITIALIZER(QUERY_TYPE_UNDEFINED);
#if DILIGENT_CPP_INTERFACE
QueryDesc() noexcept {};
explicit QueryDesc(QUERY_TYPE _Type) noexcept :
Type(_Type)
{}
#endif
};
typedef struct QueryDesc QueryDesc;
#define DILIGENT_INTERFACE_NAME IQuery
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
#define IQueryInclusiveMethods \
IDeviceObjectInclusiveMethods; \
IQueryMethods Query
// clang-format off
/// Query interface.
/// Defines the methods to manipulate a Query object
DILIGENT_BEGIN_INTERFACE(IQuery, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
/// Returns the Query description used to create the object.
virtual const QueryDesc& METHOD(GetDesc)() const override = 0;
#endif
/// Gets the query data.
/// \param [in] pData - Pointer to the query data structure. Depending on the type of the query,
/// this must be the pointer to Diligent::QueryDataOcclusion, Diligent::QueryDataBinaryOcclusion,
/// Diligent::QueryDataTimestamp, or Diligent::QueryDataPipelineStatistics
/// structure.
/// An application may provide nullptr to only check the query status.
/// \param [in] DataSize - Size of the data structure.
/// \param [in] AutoInvalidate - Whether to invalidate the query if the results are available and release associated resources.
/// An application should typically always invalidate completed queries unless
/// it needs to retrieve the same data through GetData() multiple times.
/// A query will not be invalidated if pData is nullptr.
///
/// \return true if the query data is available and false otherwise.
///
/// \note In Direct3D11 backend timestamp queries will only be available after FinishFrame is called
/// for the frame in which they were collected.
///
/// If AutoInvalidate is set to true, and the data have been retrieved, an application
/// must not call GetData() until it begins and ends the query again.
VIRTUAL bool METHOD(GetData)(THIS_
void* pData,
Uint32 DataSize,
bool AutoInvalidate DEFAULT_VALUE(true)) PURE;
/// Invalidates the query and releases associated resources.
VIRTUAL void METHOD(Invalidate)(THIS) PURE;
};
DILIGENT_END_INTERFACE
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
#if DILIGENT_C_INTERFACE
// clang-format off
# define IQuery_GetDesc(This) (const struct QueryDesc*)IDeviceObject_GetDesc(This)
# define IQuery_GetData(This, ...) CALL_IFACE_METHOD(Query, GetData, This, __VA_ARGS__)
# define IQuery_Invalidate(This) CALL_IFACE_METHOD(Query, Invalidate, This)
// clang-format on
#endif
DILIGENT_END_NAMESPACE // namespace Diligent
|
