Класс QOpenGLTimeMonitor
Класс QOpenGLTimeMonitor оборачивает последовательность объектов запросов таймера OpenGL. Подробнее...
| Заголовок: | #include <QOpenGLTimeMonitor> |
| CMake: | find_package(Qt6 COMPONENTS OpenGL REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::OpenGL) |
| qmake: | QT += opengl |
| С тех пор: | Qt 5.1 |
| Наследует: | QObject |
Открытые функции
| QOpenGLTimeMonitor(QObject *parent = nullptr) | |
| virtual | ~QOpenGLTimeMonitor() |
| bool | create() |
| void | destroy() |
| bool | isCreated() const |
| bool | isResultAvailable() const |
| QList<GLuint> | objectIds() const |
| int | recordSample() |
| void | reset() |
| int | sampleCount() const |
| void | setSampleCount(int sampleCount) |
| QList<GLuint64> | waitForIntervals() const |
| QList<GLuint64> | waitForSamples() const |
Подробное описание
Класс QOpenGLTimeMonitor — это удобная оболочка вокруг набора объектов запросов таймера OpenGL, используемых для измерения интервалов времени на GPU с требуемой точностью, необходимой вашему приложению рендеринга.
Объекты запросов таймера OpenGL запрашиваются последовательно для записи отметки времени GPU в интересующих позициях в вашем коде рендеринга. После того, как результаты всех запросов таймеров станут доступны, результаты могут быть извлечены, и QOpenGLTimerMonitor рассчитает для вас записанные интервалы времени.
Типичное использование этого класса — профилирование алгоритмов рендеринга вашего приложения или корректировка этих алгоритмов в реальном времени для динамического балансирования производительности/качества.
Перед использованием QOpenGLTimeMonitor в вашей функции рендеринга вы должны установить необходимое количество точек выборки, которые вы хотите записать, вызвав setSamples(). Обратите внимание, что измерение N точек выборки даст N-1 интервалов времени. После того, как вы установили количество точек выборки, вызовите функцию create() с допустимым текущим контекстом OpenGL для создания необходимых объектов запроса таймера. Эти шаги обычно выполняются только один раз в функции инициализации.
Используйте функцию recordSample() для разграничения блоков кода, содержащих команды OpenGL, время выполнения которых вы хотите измерить. Вы можете проверить доступность полученных выборок времени и интервалов времени с помощью isResultAvailable(). Вычисленные интервалы времени и исходные выборки отметки времени можно получить с помощью блокирующих функций waitForIntervals() и waitForSamples() соответственно.
После получения результатов и перед началом нового цикла взятия выборок (например, в следующем кадре) убедитесь, что вы вызвали функцию reset(), которая очистит кэшированные результаты и сбросит индекс таймера обратно к первому объекту таймера.
См. также QOpenGLTimerQuery.
Документация по функциям-членам
QOpenGLTimeMonitor::QOpenGLTimeMonitor(QObject *parent = nullptr)
Создаёт экземпляр QOpenGLTimeMonitor с заданным parent. Вы должны вызвать create() с допустимым контекстом OpenGL перед использованием.
См. также setSampleCount() и create().
[virtual] QOpenGLTimeMonitor::~QOpenGLTimeMonitor()
Удаляет QOpenGLTimeMonitor и все связанные с ним ресурсы OpenGL.
bool QOpenGLTimeMonitor::create()
Создаёт sampleCount() объектов запросов таймера OpenGL, которые будут использоваться для отслеживания времени выполнения команд OpenGL между последовательными вызовами recordSample().
Возвращает true если объекты запросов таймера OpenGL были созданы.
См. также destroy(), setSampleCount() и recordSample().
void QOpenGLTimeMonitor::destroy()
Удаляет любые объекты запросов таймера OpenGL, используемые в данном экземпляре.
См. также create().
bool QOpenGLTimeMonitor::isCreated() const
Возвращает true если базовые объекты запросов OpenGL были созданы. Если это возвращает true и связанный контекст OpenGL является текущим, то вы можете записывать образцы времени с этим объектом.
bool QOpenGLTimeMonitor::isResultAvailable() const
Возвращает true если результаты запросов таймера OpenGL доступны.
См. также waitForSamples() и waitForIntervals().
QList<GLuint> QOpenGLTimeMonitor::objectIds() const
Возвращает QList, содержащую идентификаторы объектов объектов запросов таймера OpenGL.
int QOpenGLTimeMonitor::recordSample()
Выполняет запрос таймера OpenGL в этой точке очереди команд OpenGL. Вызов этой функции в последовательности в функции рендеринга вашего приложения создаст подробности о времени GPU, затрачиваемом на выполнение команд OpenGL между последовательными вызовами этой функции.
См. также setSampleCount(), isResultAvailable(), waitForSamples() и waitForIntervals().
void QOpenGLTimeMonitor::reset()
Сбрасывает монитор времени, готов к использованию в другом кадре рендеринга. Вызовите это, когда вы получили предыдущие результаты и перед вызовом recordSample() в первый раз в следующем кадре.
См. также recordSample().
int QOpenGLTimeMonitor::sampleCount() const
Возвращает количество точек выборки, которые были запрошены с помощью setSampleCount(). Если create был успешно вызван после setSampleCount(), то возвращаемое значение будет фактическим количеством точек выборки, которые могут быть использованы.
Значение по умолчанию для sampleCount равно 2, что приводит к измерению одного интервала.
См. также setSampleCount().
void QOpenGLTimeMonitor::setSampleCount(int sampleCount)
Устанавливает количество точек выборки в sampleCount. После установки количества выборок с помощью этой функции, вы должны вызвать create() для инициализации базовых объектов запросов таймера OpenGL.
Новое sampleCount должно быть по крайней мере 2.
См. также sampleCount(), create() и recordSample().
QList<GLuint64> QOpenGLTimeMonitor::waitForIntervals() const
Возвращает QList, содержащий интервалы времени, ограниченные вызовами recordSample(). Результирующий вектор будет содержать на один элемент меньше, поскольку это представляет интервалы между, а не фактические выборки отметки времени.
Эта функция будет блокироваться до тех пор, пока OpenGL не укажет, что результаты доступны. Рекомендуется проверить доступность результата перед вызовом этой функции с помощью isResultAvailable().
END_OF_DOCUMENT_MARKERСм. также waitForSamples() и isResultAvailable().
QList<GLuint64> QOpenGLTimeMonitor::waitForSamples() const
Возвращает QList, содержащий отметки времени GPU, полученные с помощью recordSample().
Эта функция заблокируется до тех пор, пока OpenGL не укажет, что результаты доступны. Рекомендуется проверить доступность результата перед вызовом этой функции с помощью isResultAvailable().
Примечание: Эта функция работает только на системах с OpenGL >=3.3 или расширением ARB_timer_query. Подробнее см. QOpenGLTimerQuery.
См. также waitForIntervals() и isResultAvailable().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qopengltimemonitor.html