QPlatformSurfaceEvent Class

The QPlatformSurfaceEvent class is used to notify about native platform surface events. More...

Header: #include <QPlatformSurfaceEvent>
qmake: QT += gui
Since: Qt 5.5
Inherits: QEvent

This class was introduced in Qt 5.5.

Public Types

enum SurfaceEventType { SurfaceCreated, SurfaceAboutToBeDestroyed }

Public Functions

QPlatformSurfaceEvent(QPlatformSurfaceEvent::SurfaceEventType surfaceEventType)
QPlatformSurfaceEvent::SurfaceEventType surfaceEventType() const

Detailed Description

Platform window events are synchronously sent to windows and offscreen surfaces when their underlying native surfaces are created or are about to be destroyed.

Applications can respond to these events to know when the underlying platform surface exists.

Member Type Documentation

enum QPlatformSurfaceEvent::SurfaceEventType

This enum describes the type of platform surface event. The possible types are:

QPlatformSurfaceEvent::SurfaceCreated0The underlying native surface has been created
QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed1The underlying native surface will be destroyed immediately after this event

The SurfaceAboutToBeDestroyed event type is useful as a means of stopping rendering to a platform window before it is destroyed.

Member Function Documentation

QPlatformSurfaceEvent::QPlatformSurfaceEvent(QPlatformSurfaceEvent::SurfaceEventType surfaceEventType)

Constructs a platform surface event for the given surfaceEventType.

QPlatformSurfaceEvent::SurfaceEventType QPlatformSurfaceEvent::surfaceEventType() const

Returns the specific type of platform surface event.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.