Класс QOpenGLWindow

Класс QOpenGLWindow — это удобный подкласс QWindow для выполнения отрисовки OpenGL. Подробнее...

• Список всех членов, включая унаследованные

Типы публичного доступа

Функции публичного доступа

Сигналы

Защищённые функции

Переопределённые защищённые функции

Подробное описание

QOpenGLWindow — это расширенный QWindow, который позволяет легко создавать окна для выполнения рендеринга OpenGL с API, совместимым с QOpenGLWidget. В отличие от QOpenGLWidget, QOpenGLWindow не зависит от модуля виджетов и предлагает лучшую производительность.

Типичное приложение будет наследовать QOpenGLWindow и переопределять следующие виртуальные функции:

• initializeGL() для инициализации ресурсов OpenGL
• resizeGL() для настройки матриц преобразования и других ресурсов, зависящих от размера окна
• paintGL() для выдачи команд OpenGL или отрисовки с помощью QPainter

Для планирования перерисовки вызовите функцию update(). Обратите внимание, что это не приведет к немедленному вызову paintGL(). Вызов update() несколько раз подряд не повлияет на поведение.

Это слот, поэтому его можно подключить к сигналу QTimer::timeout() для выполнения анимации. Однако в современном мире OpenGL гораздо лучше полагаться на синхронизацию с частотой вертикальной развертки дисплея. См. setSwapInterval() для описания интервала обновления. С интервалом обновления 1, который установлен по умолчанию на большинстве систем, вызов swapBuffers(), выполняемый внутри QOpenGLWindow после каждой перерисовки, будет блокироваться и ждать vsync. Это означает, что всякий раз, когда обмен выполняется, можно запланировать обновление повторно, вызвав update(), не полагаясь на таймеры.

Для запроса определенной конфигурации контекста используйте setFormat(), как и для любого другого QWindow. Это позволяет, среди прочего, запросить определенную версию и профиль OpenGL или включить буферы глубины и трафарета.

В отличие от QWindow, QOpenGLWindow позволяет открывать painter для себя и выполнять отрисовку на основе QPainter.

QOpenGLWindow поддерживает несколько стратегий обновления. По умолчанию, NoPartialUpdate эквивалентно обычному окну OpenGL QWindow. В отличие от этого, PartialUpdateBlit и PartialUpdateBlend больше соответствуют способу работы QOpenGLWidget, где всегда существует дополнительный выделенный буфер кадра. Эти режимы позволяют, жертвуя некоторыми производительностью, перерисовывать только меньшую область при каждой перерисовке и сохранять остальное содержимое из предыдущего кадра. Это полезно для приложений, которые выполняют рендеринг по частям с использованием QPainter, так как таким образом им не нужно перерисовывать всё содержимое окна при каждом вызове paintGL().

Аналогично QOpenGLWidget, QOpenGLWindow поддерживает атрибут Qt::AA_ShareOpenGLContexts. При включенном значении контексты OpenGL всех экземпляров QOpenGLWindow будут общими. Это позволяет получать доступ к общим ресурсам OpenGL друг друга.

Для получения дополнительной информации о графике в Qt см. Графика.

Документация по типам членов

Перечисление QOpenGLWindow::UpdateBehavior

Это перечисление описывает стратегию обновления QOpenGLWindow.

Документация по функциям членов

QOpenGLWindow::QOpenGLWindow(QOpenGLContext *shareContext, QOpenGLWindow::UpdateBehavior updateBehavior = NoPartialUpdate, QWindow *parent = nullptr)

Создаёт новый QOpenGLWindow с заданным parent и updateBehavior. Контекст QOpenGLWindow будет использовать общий контекст с shareContext.

См. также QOpenGLWindow::UpdateBehavior и shareContext.

QOpenGLWindow::QOpenGLWindow(QOpenGLWindow::UpdateBehavior updateBehavior = NoPartialUpdate, QWindow *parent = nullptr)

Создаёт новый QOpenGLWindow с заданным parent и updateBehavior.

См. также QOpenGLWindow::UpdateBehavior.

[signal] void QOpenGLWindow::frameSwapped()

Этот сигнал излучается после потенциально блокирующей смены буферов. Приложения, которые хотят непрерывно перерисовывать синхронизированно с вертикальной разверткой, должны вызвать update() при этом сигнале. Это позволяет получить гораздо более плавную работу по сравнению с традиционным использованием таймеров.

[virtual, since 5.5] QOpenGLWindow::~QOpenGLWindow()

Уничтожает экземпляр QOpenGLWindow, освобождая его ресурсы.

Контекст OpenGLWindow делается текущим в деструкторе, позволяя безопасно уничтожить любой дочерний объект, который может потребоваться освободить ресурсы OpenGL, принадлежащие контексту, предоставляемому этим окном.

Эта функция была добавлена в Qt 5.5.

См. также makeCurrent.

QOpenGLContext *QOpenGLWindow::context() const

Возвращает QOpenGLContext, используемый этим окном, или 0 если он ещё не инициализирован.

GLuint QOpenGLWindow::defaultFramebufferObject() const

Дескриптор объекта фреймбуфера, используемого этим окном.

Когда поведение обновления установлено в NoPartialUpdate, нет отдельного объекта фреймбуфера. В этом случае возвращаемое значение — идентификатор стандартного фреймбуфера.

В противном случае значение идентификатора объекта фреймбуфера или 0 если он ещё не инициализирован.

void QOpenGLWindow::doneCurrent()

Освобождает контекст.

В большинстве случаев вызывать эту функцию не требуется, так как виджет позаботится о том, чтобы контекст был привязан и правильно освобождён при вызове paintGL().

См. также makeCurrent().

QImage QOpenGLWindow::grabFramebuffer()

Возвращает копию фреймбуфера.

[virtual protected] void QOpenGLWindow::initializeGL()

Этот виртуальный метод вызывается один раз перед первым вызовом paintGL() или resizeGL(). Переопределите его в подклассе.

В этом методе должны быть настроены все необходимые ресурсы и состояние OpenGL.

Вызывать makeCurrent() не нужно, так как это уже сделано при вызове этого метода. Однако обратите внимание, что фреймбуфер, в случае использования режима частичного обновления, ещё недоступен на этом этапе, поэтому избегайте вызовов рисования отсюда. Отложите такие вызовы до paintGL() вместо этого.

См. также paintGL() и resizeGL().

bool QOpenGLWindow::isValid() const

Возвращает true если ресурсы OpenGL окна, такие как контекст, были успешно инициализированы. Обратите внимание, что возвращаемое значение всегда false до тех пор, пока окно не станет видимым (отображенным).

void QOpenGLWindow::makeCurrent()

Подготавливает к отрисовке содержимого OpenGL для этого окна, делая соответствующий контекст текущим и связывая объект фреймбуфера, если он есть, в этом контексте.

В большинстве случаев вызывать эту функцию не требуется, так как она вызывается автоматически перед вызовом paintGL(). Она всё же предоставляется для поддержки расширенных многопоточных сценариев, когда поток, отличный от потока GUI или главного потока, хочет обновить поверхность или содержимое фреймбуфера. См. QOpenGLContext для получения дополнительной информации о проблемах, связанных с многопоточностью.

Эта функция также подходит для вызова, когда окно платформы уже уничтожено. Это означает, что эту функцию безопасно вызывать из деструктора подкласса QOpenGLWindow. Если родного окна больше нет, вместо него используется внеэкранная поверхность. Это гарантирует, что операции очистки ресурсов OpenGL в деструкторе всегда будут работать, если эта функция вызывается первой.

См. также QOpenGLContext, context(), paintGL() и doneCurrent().

[override virtual protected] void QOpenGLWindow::paintEvent(QPaintEvent *event)

Переопределяет: QPaintDeviceWindow::paintEvent(QPaintEvent *event).

Обработчик события event. Вызывает paintGL().

См. также paintGL().

[virtual protected] void QOpenGLWindow::paintGL()

Этот виртуальный метод вызывается всякий раз, когда нужно обновить содержимое окна. Переопределите его в подклассе.

Вызывать makeCurrent() не нужно, так как это уже сделано при вызове этого метода.

Перед вызовом этой функции контекст и фреймбуфер, если он есть, привязываются, а viewport настраивается вызовом glViewport(). Никакие другие состояния не устанавливаются, и никакое очищение или рисование не выполняется фреймворком.

См. также initializeGL(), resizeGL(), paintUnderGL(), paintOverGL() и UpdateBehavior.

[virtual protected] void QOpenGLWindow::paintOverGL()

Этот виртуальный метод вызывается после каждого вызова paintGL().

Когда режим обновления установлен в NoPartialUpdate, нет никакой разницы между этой функцией и paintGL(), отрисовка в любой из них приводит к одному и тому же результату.

Как и paintUnderGL(), отрисовка в этой функции направлена на стандартный фреймбуфер окна, независимо от поведения обновления. Она вызывается после того, как paintGL() вернулась и копирование (PartialUpdateBlit) или рисование прямоугольника (PartialUpdateBlend) было выполнено.

См. также paintGL(), paintUnderGL() и UpdateBehavior.

[virtual protected] void QOpenGLWindow::paintUnderGL()

Виртуальный метод вызывается перед каждым вызовом paintGL().

Когда режим обновления установлен в NoPartialUpdate, нет никакой разницы между этой функцией и paintGL(), отрисовка в любой из них приводит к одному и тому же результату.

Разница становится значительной при использовании PartialUpdateBlend, где используется дополнительный объект фреймбуфера. Там paintGL() обращается к этому дополнительному объекту фреймбуфера, который сохраняет его содержимое, в то время как paintUnderGL() и paintOverGL() обращаются к стандартному фреймбуферу, т. е. непосредственно к поверхности окна, содержимое которой теряется после каждого отображаемого кадра.

См. также paintGL(), paintOverGL() и UpdateBehavior.

[override virtual protected] void QOpenGLWindow::resizeEvent(QResizeEvent *event)

Реализует: QWindow::resizeEvent(QResizeEvent *ev).

Обработчик события изменения размера event. Вызывает resizeGL().

См. также resizeGL().

[virtual protected] void QOpenGLWindow::resizeGL(int w, int h)

Эта виртуальная функция вызывается всякий раз, когда виджет был изменен по размеру. Переопределите её в подклассе. Новый размер передаётся в w и h.

См. также initializeGL() и paintGL().

QOpenGLContext *QOpenGLWindow::shareContext() const

Возвращает QOpenGLContext, который требуется для совместного использования с QOpenGLContext этого окна.

QOpenGLWindow::UpdateBehavior QOpenGLWindow::updateBehavior() const

Возвращает поведение обновления для этого QOpenGLWindow.