Skip to content

OpenGLWidget

Qt Base Class: QOpenGLWidget

Signature: QOpenGLWidget(self, parent: Optional[PySide6.QtWidgets.QWidget] = None, f: PySide6.QtCore.Qt.WindowType = Default(Qt.WindowFlags)) -> None

Base classes

Name Children Inherits
WidgetMixin
prettyqt.widgets.widget
QOpenGLWidget
PySide6.QtOpenGLWidgets
QOpenGLWidget(self, parent: Optional[PySide6.QtWidgets.QWidget] \= None, f: PySide6.QtCore.Qt.WindowType \= Default(Qt.WindowFlags)) -> None

⋔ Inheritance diagram

graph TD
  1473572190064["openglwidgets.OpenGLWidget"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473369353328["QtOpenGLWidgets.QOpenGLWidget"]
  1473290849680["QtWidgets.QWidget"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473300082368["QtGui.QPaintDevice"]
  1473293688240 --> 1473572190064
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480
  1473369353328 --> 1473572190064
  1473290849680 --> 1473369353328
  1473288842240 --> 1473290849680
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208
  1473300082368 --> 1473290849680
  1473291690208 --> 1473300082368

🛈 DocStrings

Bases: WidgetMixin, QOpenGLWidget

Widget for rendering OpenGL graphics.

Source code in prettyqt\openglwidgets\openglwidget.py
class OpenGLWidget(widgets.WidgetMixin, QtOpenGLWidgets.QOpenGLWidget):
    """Widget for rendering OpenGL graphics."""

    def set_update_behavior(
        self, behavior: UpdateBehaviorStr | QtOpenGLWidgets.QOpenGLWidget.UpdateBehavior
    ):
        """Set update behavior.

        Args:
            behavior: update behavior to use
        """
        self.setUpdateBehavior(UPDATE_BEHAVIOR.get_enum_value(behavior))

    def get_update_behavior(self) -> UpdateBehaviorStr | None:
        """Return current update behavior.

        Returns:
            update behavior
        """
        return UPDATE_BEHAVIOR.inverse[self.updateBehavior()]

    def get_current_target_buffer(self) -> TargetBufferStr:
        """Return current target buffer.

        Returns:
            target buffer
        """
        return TARGET_BUFFER.inverse[self.currentTargetBuffer()]

get_current_target_buffer() -> TargetBufferStr

Return current target buffer.

Source code in prettyqt\openglwidgets\openglwidget.py
def get_current_target_buffer(self) -> TargetBufferStr:
    """Return current target buffer.

    Returns:
        target buffer
    """
    return TARGET_BUFFER.inverse[self.currentTargetBuffer()]

get_update_behavior() -> UpdateBehaviorStr | None

Return current update behavior.

Source code in prettyqt\openglwidgets\openglwidget.py
def get_update_behavior(self) -> UpdateBehaviorStr | None:
    """Return current update behavior.

    Returns:
        update behavior
    """
    return UPDATE_BEHAVIOR.inverse[self.updateBehavior()]

set_update_behavior(behavior: UpdateBehaviorStr | QtOpenGLWidgets.QOpenGLWidget.UpdateBehavior)

Set update behavior.

Parameters:

Name Type Description Default
behavior UpdateBehaviorStr | UpdateBehavior

update behavior to use

required
Source code in prettyqt\openglwidgets\openglwidget.py
def set_update_behavior(
    self, behavior: UpdateBehaviorStr | QtOpenGLWidgets.QOpenGLWidget.UpdateBehavior
):
    """Set update behavior.

    Args:
        behavior: update behavior to use
    """
    self.setUpdateBehavior(UPDATE_BEHAVIOR.get_enum_value(behavior))

⌗ Property table

Qt Property Type Doc
objectName QString
modal bool
windowModality Qt::WindowModality
enabled bool
geometry QRect
frameGeometry QRect
normalGeometry QRect
x int
y int
pos QPoint
frameSize QSize
size QSize
width int
height int
rect QRect
childrenRect QRect
childrenRegion QRegion
sizePolicy QSizePolicy
minimumSize QSize
maximumSize QSize
minimumWidth int
minimumHeight int
maximumWidth int
maximumHeight int
sizeIncrement QSize
baseSize QSize
palette QPalette
font QFont
cursor QCursor
mouseTracking bool
tabletTracking bool
isActiveWindow bool
focusPolicy Qt::FocusPolicy
focus bool
contextMenuPolicy Qt::ContextMenuPolicy
updatesEnabled bool
visible bool
minimized bool
maximized bool
fullScreen bool
sizeHint QSize
minimumSizeHint QSize
acceptDrops bool
windowTitle QString
windowIcon QIcon
windowIconText QString
windowOpacity double
windowModified bool
toolTip QString
toolTipDuration int
statusTip QString
whatsThis QString
accessibleName QString
accessibleDescription QString
layoutDirection Qt::LayoutDirection
autoFillBackground bool
styleSheet QString
locale QLocale
windowFilePath QString
inputMethodHints QFlags