API reference - Class QOffscreenSurface

_const_cast

Signature: [const] QOffscreenSurface ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

asConstQObject

Signature: [const] const QObject ptr asConstQObject

Description: Delivers the base class interface QObject of QOffscreenSurface

Class QOffscreenSurface is derived from multiple base classes. This method delivers the QObject base class aspect.

Use this version if you have a const reference.

asConstQSurface

Signature: [const] const QSurface ptr asConstQSurface

Description: Delivers the base class interface QSurface of QOffscreenSurface

Class QOffscreenSurface is derived from multiple base classes. This method delivers the QSurface base class aspect.

Use this version if you have a const reference.

asQObject

Signature: QObject ptr asQObject

Description: Delivers the base class interface QObject of QOffscreenSurface

Class QOffscreenSurface is derived from multiple base classes. This method delivers the QObject base class aspect.

asQSurface

Signature: QSurface ptr asQSurface

Description: Delivers the base class interface QSurface of QOffscreenSurface

Class QOffscreenSurface is derived from multiple base classes. This method delivers the QSurface base class aspect.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QOffscreenSurface::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

create

Signature: void create

Description: Method void QOffscreenSurface::create()

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QOffscreenSurface::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroy

Signature: void destroy

Description: Method void QOffscreenSurface::destroy()

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QOffscreenSurface::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QOffscreenSurface::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QOffscreenSurface::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QOffscreenSurface::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_screenChanged

Signature: void emit_screenChanged (QScreen ptr screen)

Description: Emitter for signal void QOffscreenSurface::screenChanged(QScreen *screen)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QOffscreenSurface::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QOffscreenSurface::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

format

Signature: [const] QSurfaceFormat format

Description: Virtual method QSurfaceFormat QOffscreenSurface::format()

This method can be reimplemented in a derived class.

format=

Signature: void format= (const QSurfaceFormat format)

Description: Method void QOffscreenSurface::setFormat(const QSurfaceFormat &format)

Python specific notes:
The object exposes a writable attribute 'format'. This is the setter.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QOffscreenSurface::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

isValid?

Signature: [const] bool isValid?

Description: Method bool QOffscreenSurface::isValid()

nativeHandle

Signature: [const] void * nativeHandle

Description: Method void *QOffscreenSurface::nativeHandle()

Python specific notes:
The object exposes a readable attribute 'nativeHandle'. This is the getter.

nativeHandle=

Signature: void nativeHandle= (void * handle)

Description: Method void QOffscreenSurface::setNativeHandle(void *handle)

Python specific notes:
The object exposes a writable attribute 'nativeHandle'. This is the setter.

new

(1) Signature: [static] new QOffscreenSurface new (QScreen ptr screen, QObject ptr parent)

Description: Constructor QOffscreenSurface::QOffscreenSurface(QScreen *screen, QObject *parent)

This method creates an object of class QOffscreenSurface.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QOffscreenSurface new (QScreen ptr screen = nullptr)

Description: Constructor QOffscreenSurface::QOffscreenSurface(QScreen *screen)

This method creates an object of class QOffscreenSurface.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QOffscreenSurface::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

qt_create

Signature: void qt_create

Description: Method void QOffscreenSurface::create()

qt_destroy

Signature: void qt_destroy

Description: Method void QOffscreenSurface::destroy()

receivers

Signature: [const] int receivers (string signal)

Description: Method int QOffscreenSurface::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

requestedFormat

Signature: [const] QSurfaceFormat requestedFormat

Description: Method QSurfaceFormat QOffscreenSurface::requestedFormat()

screen

Signature: [const] QScreen ptr screen

Description: Method QScreen *QOffscreenSurface::screen()

Python specific notes:
The object exposes a readable attribute 'screen'. This is the getter.

screen=

Signature: void screen= (QScreen ptr screen)

Description: Method void QOffscreenSurface::setScreen(QScreen *screen)

Python specific notes:
The object exposes a writable attribute 'screen'. This is the setter.

screenChanged

Signature: [signal] void screenChanged (QScreen ptr screen)

Description: Signal declaration for QOffscreenSurface::screenChanged(QScreen *screen)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'screenChanged'. This is the getter.
The object exposes a writable attribute 'screenChanged'. This is the setter.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QOffscreenSurface::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QOffscreenSurface::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setFormat

Signature: void setFormat (const QSurfaceFormat format)

Description: Method void QOffscreenSurface::setFormat(const QSurfaceFormat &format)

Python specific notes:
The object exposes a writable attribute 'format'. This is the setter.

setNativeHandle

Signature: void setNativeHandle (void * handle)

Description: Method void QOffscreenSurface::setNativeHandle(void *handle)

Python specific notes:
The object exposes a writable attribute 'nativeHandle'. This is the setter.

setScreen

Signature: void setScreen (QScreen ptr screen)

Description: Method void QOffscreenSurface::setScreen(QScreen *screen)

Python specific notes:
The object exposes a writable attribute 'screen'. This is the setter.

size

Signature: [const] QSize size

Description: Virtual method QSize QOffscreenSurface::size()

This method can be reimplemented in a derived class.

Python specific notes:
This method is also available as 'len(object)'.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

surfaceType

Signature: [const] QSurface_SurfaceType surfaceType

Description: Virtual method QSurface::SurfaceType QOffscreenSurface::surfaceType()

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QOffscreenSurface::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QOffscreenSurface::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QOffscreenSurface::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.