Skip to content

PythonQt.QtGui.QOffscreenSurface · declarations 001

Back to PythonQt.QtGui.QOffscreenSurface

Offscreen instance-attribute

Offscreen: Any

OpenGLSurface instance-attribute

OpenGLSurface: Any

RasterGLSurface instance-attribute

RasterGLSurface: Any

RasterSurface instance-attribute

RasterSurface: Any

SurfaceClass instance-attribute

SurfaceClass: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

SurfaceType instance-attribute

SurfaceType: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

create

create() -> None

X.create()

Supplemental documentation: Qt 5 reference:

void QOffscreenSurface::create()

Allocates the platform resources associated with the offscreen surface.

It is at this point that the surface format set using setFormat() gets resolved into an actual native surface.

Call destroy() to free the platform resources if necessary.

Note: Some platforms require this function to be called on the main (GUI) thread.

See also destroy().

Upstream PySide2 reference signatures (binding differences may apply):

create(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#create

destroy

destroy() -> None

X.destroy()

Supplemental documentation: Qt 5 reference:

void QOffscreenSurface::destroy()

Releases the native platform resources associated with this offscreen surface.

See also create().

Upstream PySide2 reference signatures (binding differences may apply):

destroy(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#destroy

destroyed

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

Native PythonQt.QtGui.QOffscreenSurface.destroyed; argument details are not documented.

format

format() -> Any

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

Supplemental documentation: Qt 5 reference:

[override virtual] QSurfaceFormat QOffscreenSurface::format() const

Reimplements: QSurface::format() const.

Returns the actual format of this offscreen surface.

After the offscreen surface has been created, this function will return the actual surface format of the surface. It might differ from the requested format if the requested format could not be fulfilled by the platform.

See also setFormat(), create(), and requestedFormat().

Upstream PySide2 reference signatures (binding differences may apply):

format(self) -> PySide2.QtGui.QSurfaceFormat

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#format

isValid

isValid() -> bool

X.isValid() -> bool

Supplemental documentation: Qt 5 reference:

bool QOffscreenSurface::isValid() const

Returns true if this offscreen surface is valid; otherwise returns false.

The offscreen surface is valid if the platform resources have been successfuly allocated.

See also create().

Upstream PySide2 reference signatures (binding differences may apply):

isValid(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#isValid

objectNameChanged

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

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

requestedFormat

requestedFormat() -> Any

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

Supplemental documentation: Qt 5 reference:

QSurfaceFormat QOffscreenSurface::requestedFormat() const

Returns the requested surfaceformat of this offscreen surface.

If the requested format was not supported by the platform implementation, the requestedFormat will differ from the actual offscreen surface format.

This is the value set with setFormat().

See also setFormat() and format().

Upstream PySide2 reference signatures (binding differences may apply):

requestedFormat(self) -> PySide2.QtGui.QSurfaceFormat

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#requestedFormat

screen

screen() -> Any

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

Supplemental documentation: Qt 5 reference:

QScreen *QOffscreenSurface::screen() const

Returns the screen to which the offscreen surface is connected.

See also setScreen().

Upstream PySide2 reference signatures (binding differences may apply):

screen(self) -> PySide2.QtGui.QScreen

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#screen

screenChanged

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

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

Supplemental documentation: Qt 5 reference:

[signal] void QOffscreenSurface::screenChanged(QScreen *screen)

This signal is emitted when an offscreen surface's screen changes, either by being set explicitly with setScreen(), or automatically when the window's screen is removed.

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#screenChanged

setFormat

setFormat(format: Any) -> None

X.setFormat(format)

Supplemental documentation: Qt 5 reference:

void QOffscreenSurface::setFormat(const QSurfaceFormat \&format)

Sets the offscreen surface format.

The surface format will be resolved in the create() function. Calling this function after create() will not re-resolve the surface format of the native surface.

See also format(), create(), and destroy().

Upstream PySide2 reference signatures (binding differences may apply):

setFormat(self, format: PySide2.QtGui.QSurfaceFormat) -> None

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#setFormat

setScreen

setScreen(screen: Any) -> None

X.setScreen(screen)

Supplemental documentation: Qt 5 reference:

void QOffscreenSurface::setScreen(QScreen *newScreen)

Sets the screen to which the offscreen surface is connected.

If the offscreen surface has been created, it will be recreated on the newScreen.

See also screen().

Upstream PySide2 reference signatures (binding differences may apply):

setScreen(self, screen: PySide2.QtGui.QScreen) -> None

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#setScreen

size

size() -> Any

X.size() -> PythonQt.QtCore.QSize

Supplemental documentation: Qt 5 reference:

[override virtual] QSize QOffscreenSurface::size() const

Reimplements: QSurface::size() const.

Returns the size of the offscreen surface.

Upstream PySide2 reference signatures (binding differences may apply):

size(self) -> PySide2.QtCore.QSize

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#size

supportsOpenGL

supportsOpenGL() -> bool

X.supportsOpenGL() -> bool

surfaceClass

surfaceClass() -> Any

X.surfaceClass()

surfaceHandle

surfaceHandle() -> int

X.surfaceHandle()

Upstream PySide2 reference signatures (binding differences may apply):

surfaceHandle(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#surfaceHandle

surfaceType

surfaceType() -> Any

X.surfaceType()

Supplemental documentation: Qt 5 reference:

[override virtual] QSurface::SurfaceType QOffscreenSurface::surfaceType() const

Reimplements: QSurface::surfaceType() const.

Returns the surface type of the offscreen surface.

The surface type of an offscreen surface is always QSurface::OpenGLSurface.

Upstream PySide2 reference signatures (binding differences may apply):

surfaceType(self) -> PySide2.QtGui.QSurface.SurfaceType

Source: https://doc.qt.io/archives/qt-5.15/qoffscreensurface.html#surfaceType