Skip to content

PythonQt.QtGui.QOpenGLWindow · declarations 002

Back to PythonQt.QtGui.QOpenGLWindow

keyReleaseEvent

keyReleaseEvent(arg__1: Any) -> Any

X.keyReleaseEvent(arg__1)

makeCurrent

makeCurrent() -> None

X.makeCurrent()

Supplemental documentation: Qt 5 reference:

void QOpenGLWindow::makeCurrent()

Prepares for rendering OpenGL content for this window by making the corresponding context current and binding the framebuffer object, if there is one, in that context context.

It is not necessary to call this function in most cases, because it is called automatically before invoking paintGL(). It is provided nonetheless to support advanced, multi-threaded scenarios where a thread different than the GUI or main thread may want to update the surface or framebuffer contents. See QOpenGLContext for more information on threading related issues.

This function is suitable for calling also when the underlying platform window is already destroyed. This means that it is safe to call this function from a QOpenGLWindow subclass' destructor. If there is no native window anymore, an offscreen surface is used instead. This ensures that OpenGL resource cleanup operations in the destructor will always work, as long as this function is called first.

See also QOpenGLContext, context(), paintGL(), and doneCurrent().

Upstream PySide2 reference signatures (binding differences may apply):

makeCurrent(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#makeCurrent

mapFromGlobal

mapFromGlobal(pos: Any) -> Any

X.mapFromGlobal(pos) -> PythonQt.QtCore.QPoint

mapToGlobal

mapToGlobal(pos: Any) -> Any

X.mapToGlobal(pos) -> PythonQt.QtCore.QPoint

maximumHeightChanged

maximumHeightChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLWindow.maximumHeightChanged; argument details are not documented.

maximumWidthChanged

maximumWidthChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLWindow.maximumWidthChanged; argument details are not documented.

metric

metric(metric: Any) -> int

X.metric(metric) -> int

Upstream PySide2 reference signatures (binding differences may apply):

metric(self, metric: PySide2.QtGui.QPaintDevice.PaintDeviceMetric) -> int

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#metric

minimumHeightChanged

minimumHeightChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLWindow.minimumHeightChanged; argument details are not documented.

minimumWidthChanged

minimumWidthChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLWindow.minimumWidthChanged; argument details are not documented.

modality instance-attribute

modality: Any

modalityChanged

modalityChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLWindow.modalityChanged; argument details are not documented.

moveEvent

moveEvent(arg__1: Any) -> Any

X.moveEvent(arg__1)

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLWindow.objectNameChanged; argument details are not documented.

opacityChanged

opacityChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLWindow.opacityChanged; argument details are not documented.

paintEvent

paintEvent(event: Any) -> None

X.paintEvent(event)

Supplemental documentation: Qt 5 reference:

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

Reimplements: QPaintDeviceWindow::paintEvent(QPaintEvent *event).

Paint event handler. Calls paintGL().

See also paintGL().

Upstream PySide2 reference signatures (binding differences may apply):

paintEvent(self, event: PySide2.QtGui.QPaintEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#paintEvent

paintGL

paintGL() -> None

X.paintGL()

Supplemental documentation: Qt 5 reference:

[virtual protected] void QOpenGLWindow::paintGL()

This virtual function is called whenever the window contents needs to be painted. Reimplement it in a subclass.

There is no need to call makeCurrent() because this has already been done when this function is called.

Before invoking this function, the context and the framebuffer, if there is one, are bound, and the viewport is set up by a call to glViewport(). No other state is set and no clearing or drawing is performed by the framework.

Note: When using a partial update behavior, like PartialUpdateBlend, the output of the previous paintGL() call is preserved and, after the additional drawing perfomed in the current invocation of the function, the content is blitted or blended over the content drawn directly to the window in paintUnderGL().

See also initializeGL(), resizeGL(), paintUnderGL(), paintOverGL(), and UpdateBehavior.

Upstream PySide2 reference signatures (binding differences may apply):

paintGL(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#paintGL

paintOverGL

paintOverGL() -> None

X.paintOverGL()

Supplemental documentation: Qt 5 reference:

[virtual protected] void QOpenGLWindow::paintOverGL()

This virtual function is called after each invocation of paintGL().

When the update mode is set to NoPartialUpdate, there is no difference between this function and paintGL(), performing rendering in either of them leads to the same result.

Like paintUnderGL(), rendering in this function targets the default framebuffer of the window, regardless of the update behavior. It gets called after paintGL() has returned and the blit (PartialUpdateBlit) or quad drawing (PartialUpdateBlend) has been done.

See also paintGL(), paintUnderGL(), and UpdateBehavior.

Upstream PySide2 reference signatures (binding differences may apply):

paintOverGL(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#paintOverGL

paintUnderGL

paintUnderGL() -> None

X.paintUnderGL()

Supplemental documentation: Qt 5 reference:

[virtual protected] void QOpenGLWindow::paintUnderGL()

The virtual function is called before each invocation of paintGL().

When the update mode is set to NoPartialUpdate, there is no difference between this function and paintGL(), performing rendering in either of them leads to the same result.

The difference becomes significant when using PartialUpdateBlend, where an extra framebuffer object is used. There, paintGL() targets this additional framebuffer object, which preserves its contents, while paintUnderGL() and paintOverGL() target the default framebuffer, i.e. directly the window surface, the contents of which is lost after each displayed frame.

Note: Avoid relying on this function when the update behavior is PartialUpdateBlit. This mode involves blitting the extra framebuffer used by paintGL() onto the default framebuffer after each invocation of paintGL(), thus overwriting all drawing generated in this function.

See also paintGL(), paintOverGL(), and UpdateBehavior.

Upstream PySide2 reference signatures (binding differences may apply):

paintUnderGL(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#paintUnderGL

parent

parent() -> Any

X.parent() -> PythonQt.QtGui.QWindow

position

position() -> Any

X.position() -> PythonQt.QtCore.QPoint

redirected

redirected(arg__1: Any) -> Any

X.redirected(arg__1) -> PythonQt.QtGui.QPaintDevice

Upstream PySide2 reference signatures (binding differences may apply):

redirected(self, arg__1: PySide2.QtCore.QPoint) -> PySide2.QtGui.QPaintDevice

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#redirected

reportContentOrientationChange

reportContentOrientationChange(orientation: Any) -> Any

X.reportContentOrientationChange(orientation)

requestActivate

requestActivate() -> Any

X.requestActivate()

requestUpdate

requestUpdate() -> Any

X.requestUpdate()

requestedFormat

requestedFormat() -> Any

X.requestedFormat() -> PythonQt.QtGui.QSurfaceFormat

resizeEvent

resizeEvent(event: Any) -> None

X.resizeEvent(event)

Supplemental documentation: Qt 5 reference:

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

Reimplements: QWindow::resizeEvent(QResizeEvent *ev).

Resize event handler. Calls resizeGL().

See also resizeGL().

Upstream PySide2 reference signatures (binding differences may apply):

resizeEvent(self, event: PySide2.QtGui.QResizeEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#resizeEvent

resizeGL

resizeGL(w: int, h: int) -> None

X.resizeGL(w, h)

Supplemental documentation: Qt 5 reference:

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

This virtual function is called whenever the widget has been resized. Reimplement it in a subclass. The new size is passed in w and h.

Note: This is merely a convenience function in order to provide an API that is compatible with QOpenGLWidget. Unlike with QOpenGLWidget, derived classes are free to choose to override resizeEvent() instead of this function.

Note: Avoid issuing OpenGL commands from this function as there may not be a context current when it is invoked. If it cannot be avoided, call makeCurrent().

Note: Scheduling updates from here is not necessary. The windowing systems will send expose events that trigger an update automatically.

See also initializeGL() and paintGL().

Upstream PySide2 reference signatures (binding differences may apply):

resizeGL(self, w: int, h: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglwindow.html#resizeGL

screen

screen() -> Any

X.screen() -> PythonQt.QtGui.QScreen

screenChanged

screenChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLWindow.screenChanged; argument details are not documented.

setBaseSize

setBaseSize(size: Any) -> Any

X.setBaseSize(size)

setFilePath

setFilePath(filePath: Any) -> Any

X.setFilePath(filePath)

setFormat

setFormat(format: Any) -> Any

X.setFormat(format)

setFramePosition

setFramePosition(point: Any) -> Any

X.setFramePosition(point)

setGeometry

setGeometry(posx: Any, posy: Any, w: Any, h: Any) -> Any

X.setGeometry(posx, posy, w, h)

setHeight

setHeight(arg: Any) -> Any

X.setHeight(arg)

setKeyboardGrabEnabled

setKeyboardGrabEnabled(grab: Any) -> bool

X.setKeyboardGrabEnabled(grab) -> bool

setMask

setMask(region: Any) -> Any

X.setMask(region)

setMaximumHeight

setMaximumHeight(h: Any) -> Any

X.setMaximumHeight(h)

setMaximumSize

setMaximumSize(size: Any) -> Any

X.setMaximumSize(size)

setMaximumWidth

setMaximumWidth(w: Any) -> Any

X.setMaximumWidth(w)