1/****************************************************************************
2**
3** Copyright (C) 2019 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the Qt Gui module
7**
8** $QT_BEGIN_LICENSE:LGPL3$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPLv3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or later as published by the Free
28** Software Foundation and appearing in the file LICENSE.GPL included in
29** the packaging of this file. Please review the following information to
30** ensure the GNU General Public License version 2.0 requirements will be
31** met: http://www.gnu.org/licenses/gpl-2.0.html.
32**
33** $QT_END_LICENSE$
34**
35****************************************************************************/
36
37#ifndef QRHIPROFILER_H
38#define QRHIPROFILER_H
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49//
50
51#include <private/qrhi_p.h>
52
53QT_BEGIN_NAMESPACE
54
55class QRhiProfilerPrivate;
56class QIODevice;
57
58class Q_GUI_EXPORT QRhiProfiler
59{
60public:
61 enum StreamOp {
62 NewBuffer = 1,
63 ReleaseBuffer,
64 NewBufferStagingArea,
65 ReleaseBufferStagingArea,
66 NewRenderBuffer,
67 ReleaseRenderBuffer,
68 NewTexture,
69 ReleaseTexture,
70 NewTextureStagingArea,
71 ReleaseTextureStagingArea,
72 ResizeSwapChain,
73 ReleaseSwapChain,
74 NewReadbackBuffer,
75 ReleaseReadbackBuffer,
76 GpuMemAllocStats,
77 GpuFrameTime,
78 FrameToFrameTime,
79 FrameBuildTime
80 };
81
82 ~QRhiProfiler();
83
84 void setDevice(QIODevice *device);
85
86 void addVMemAllocatorStats();
87
88 int frameTimingWriteInterval() const;
89 void setFrameTimingWriteInterval(int frameCount);
90
91 struct CpuTime {
92 qint64 minTime = 0;
93 qint64 maxTime = 0;
94 float avgTime = 0;
95 };
96
97 struct GpuTime {
98 float minTime = 0;
99 float maxTime = 0;
100 float avgTime = 0;
101 };
102
103 CpuTime frameToFrameTimes(QRhiSwapChain *sc) const;
104 CpuTime frameBuildTimes(QRhiSwapChain *sc) const; // beginFrame - endFrame
105 GpuTime gpuFrameTimes(QRhiSwapChain *sc) const;
106
107private:
108 Q_DISABLE_COPY(QRhiProfiler)
109 QRhiProfiler();
110 QRhiProfilerPrivate *d;
111 friend class QRhiImplementation;
112 friend class QRhiProfilerPrivate;
113};
114
115Q_DECLARE_TYPEINFO(QRhiProfiler::CpuTime, Q_MOVABLE_TYPE);
116Q_DECLARE_TYPEINFO(QRhiProfiler::GpuTime, Q_MOVABLE_TYPE);
117
118QT_END_NAMESPACE
119
120#endif
121