Synopsis¶

Methods¶

def __init__()
def supportsOpenGL()
def surfaceClass()

Virtual methods¶

def format()
def size()
def surfaceHandle()
def surfaceType()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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 SurfaceClass¶

The SurfaceClass 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 .

Constant	Description
QSurface.Window	The surface is an instance of `QWindow` .
QSurface.Offscreen	The surface is an instance of `QOffscreenSurface` .

class SurfaceType¶

The SurfaceType enum describes what type of surface this is.

Constant

Description

QSurface.RasterSurface

The surface 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 only supported on macOS and iOS.

QSurface.Direct3DSurface

The surface is a Direct 3D 11 and 12 compatible surface and can be used in conjunction with the DXGI and Direct3D APIs. This surface type is only supported on Windows.

Constant	Description
QSurface.RasterSurface	The surface 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 only supported on macOS and iOS.
QSurface.Direct3DSurface	The surface is a Direct 3D 11 and 12 compatible surface and can be used in conjunction with the DXGI and Direct3D APIs. This surface type is only supported on Windows.

PySide6.QtGui.QSurface.m_type¶

__init__(type)¶

Parameters:: type – SurfaceClass

Creates a surface with the given type.

abstract format()¶

Return type:: QSurfaceFormat

Returns the format of the surface.

abstract size()¶

Return type:: QSize

Returns the size of the surface in pixels.

supportsOpenGL()¶

Return type:: bool

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

surfaceClass()¶

Return type:: SurfaceClass

Returns the surface class of this surface.

abstract surfaceHandle()¶

Return type:: QPlatformSurface

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

abstract surfaceType()¶

Return type:: SurfaceType

Returns the type of the surface.