QSurface

The QSurface class is an abstraction of renderable surfaces in Qt. More

Inheritance diagram of PySide2.QtGui.QSurface

Synopsis

Functions

Virtual functions

Detailed Description

The size of the surface is accessible with the size() function. The rendering specific attributes of the surface are accessible through the format() function.

class PySide2.QtGui.QSurface(type)
param type

SurfaceClass

Creates a surface with the given type .

PySide2.QtGui.QSurface.SurfaceClass

The enum describes the actual subclass of the surface.

Constant

Description

QSurface.Window

The surface is an instance of QWindow .

QSurface.Offscreen

The surface is an instance of QOffscreenSurface .

PySide2.QtGui.QSurface.SurfaceType

The enum describes what type of surface this is.

Constant

Description

QSurface.RasterSurface

The surface is is composed of pixels and can be rendered to using a software rasterizer like Qt’s raster paint engine.

QSurface.OpenGLSurface

The surface is an OpenGL compatible surface and can be used in conjunction with QOpenGLContext .

QSurface.RasterGLSurface

The surface can be rendered to using a software rasterizer, and also supports OpenGL. This surface type is intended for internal Qt use, and requires the use of private API.

QSurface.OpenVGSurface

The surface is an OpenVG compatible surface and can be used in conjunction with OpenVG contexts.

QSurface.VulkanSurface

The surface is a Vulkan compatible surface and can be used in conjunction with the Vulkan graphics API.

QSurface.MetalSurface

The surface is a Metal compatible surface and can be used in conjunction with Apple’s Metal graphics API. This surface type is supported on macOS only.

PySide2.QtGui.QSurface.m_type
PySide2.QtGui.QSurface.format()
Return type

PySide2.QtGui.QSurfaceFormat

Returns the format of the surface.

PySide2.QtGui.QSurface.size()
Return type

PySide2.QtCore.QSize

Returns the size of the surface in pixels.

PySide2.QtGui.QSurface.supportsOpenGL()
Return type

bool

Returns true if the surface is OpenGL compatible and can be used in conjunction with QOpenGLContext ; otherwise returns false.

PySide2.QtGui.QSurface.surfaceClass()
Return type

SurfaceClass

Returns the surface class of this surface.

PySide2.QtGui.QSurface.surfaceHandle()
Return type

QPlatformSurface

Returns a handle to the platform-specific implementation of the surface.

PySide2.QtGui.QSurface.surfaceType()
Return type

SurfaceType

Returns the type of the surface.