QWaylandSurface Class
La clase QWaylandSurface representa un área rectangular en un dispositivo de salida. Más información...
| Encabezado: | #include <QWaylandSurface> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS WaylandCompositor) target_link_libraries(mytarget PRIVATE Qt6::WaylandCompositor) |
| qmake: | QT += waylandcompositor |
| En QML: | WaylandSurface |
| Heredan: | QWaylandObject |
Tipos públicos
| enum | Origin { OriginTopLeft, OriginBottomLeft } |
Propiedades
|
|
Funciones públicas
| QWaylandSurface() | |
| QWaylandSurface(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version) | |
| virtual | ~QWaylandSurface() override |
| int | bufferScale() const |
| QSize | bufferSize() const |
| QWaylandClient * | client() const |
| QWaylandCompositor * | compositor() const |
| Qt::ScreenOrientation | contentOrientation() const |
| QSize | destinationSize() const |
| void | destroy() |
| void | frameStarted() |
| bool | hasContent() const |
| bool | inhibitsIdle() const |
| void | initialize(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version) |
| bool | inputRegionContains(const QPoint &p) const |
| bool | inputRegionContains(const QPointF &position) const |
| bool | isCursorSurface() const |
| bool | isDestroyed() const |
| bool | isInitialized() const |
| bool | isOpaque() const |
| void | markAsCursorSurface(bool cursorSurface) |
| QWaylandSurface::Origin | origin() const |
| QWaylandView * | primaryView() const |
| struct wl_resource * | resource() const |
| void | sendFrameCallbacks() |
| void | setPrimaryView(QWaylandView *view) |
| bool | setRole(QWaylandSurfaceRole *role, wl_resource *errorResource, uint32_t errorCode) |
| QRectF | sourceGeometry() const |
| QList<QWaylandView *> | views() const |
| wl_client * | waylandClient() const |
Ranuras públicas
| void | updateSelection() |
Señales
| void | bufferScaleChanged() |
| void | bufferSizeChanged() |
| void | childAdded(QWaylandSurface *child) |
| void | contentOrientationChanged() |
| void | cursorSurfaceChanged() |
| void | destinationSizeChanged() |
| void | dragStarted(QWaylandDrag *drag) |
| void | hasContentChanged() |
| void | inhibitsIdleChanged() |
| void | isOpaqueChanged() |
| void | originChanged() |
| void | sourceGeometryChanged() |
| void | surfaceDestroyed() |
Miembros públicos estáticos
| QWaylandSurface * | fromResource(wl_resource *resource) |
Descripción detallada
Esta clase encapsula un área rectangular de píxeles que se muestra en un dispositivo de salida. Se corresponde con la interfaz « wl_surface » del protocolo Wayland.
Documentación sobre los tipos de miembros
enum QWaylandSurface::Origin
Este tipo de enumeración se utiliza para especificar el origen del búfer de un « QWaylandSurface ».
| Constante | Valor | Descripción |
|---|---|---|
QWaylandSurface::OriginTopLeft | 0 | El origen es la esquina superior izquierda del búfer. |
QWaylandSurface::OriginBottomLeft | 1 | El origen es la esquina inferior izquierda del búfer. |
Documentación de la propiedad
[read-only] bufferScale : int
Esta propiedad contiene la escala del buffer de « QWaylandSurface ». La escala del buffer permite al cliente proporcionar datos del buffer con mayor resolución para su uso en salidas de alta resolución.
Funciones de acceso:
| int | bufferScale() const |
Señal de notificación:
| void | bufferScaleChanged() |
[read-only] bufferSize : QSize
Esta propiedad contiene el tamaño del búfer actual de este QWaylandSurface en píxeles, no en coordenadas de superficie.
Para obtener el tamaño en coordenadas de superficie, utiliza en su lugar ` destinationSize `.
Funciones de acceso:
| QSize | bufferSize() const |
Señal de notificación:
| void | bufferSizeChanged() |
Véase también « destinationSize » y « bufferScale ».
[read-only] client : QWaylandClient* const
Esta propiedad contiene el cliente que utiliza este QWaylandSurface.
Funciones de Access:
| QWaylandClient * | client() const |
[read-only] contentOrientation : Qt::ScreenOrientation
Esta propiedad define la orientación del contenido de « QWaylandSurface ».
Funciones de acceso:
| Qt::ScreenOrientation | contentOrientation() const |
Señal de notificación:
| void | contentOrientationChanged() |
Véase también QWaylandOutput::transform.
cursorSurface : bool
Esta propiedad indica si la superficie de cursor « QWaylandSurface » es una superficie de cursor.
Funciones de acceso:
| bool | isCursorSurface() const |
| void | markAsCursorSurface(bool cursorSurface) |
Señal de notificación:
| void | cursorSurfaceChanged() |
[read-only] destinationSize : QSize
Esta propiedad contiene el tamaño de este WaylandSurface en coordenadas de superficie.
Funciones de acceso:
| QSize | destinationSize() const |
Señal de notificación:
| void | destinationSizeChanged() |
Véase también « bufferScale » y « bufferSize ».
[read-only] hasContent : bool
Esta propiedad indica si la superficie tiene actualmente un búfer asignado y distinto de nulo.
Funciones de acceso:
| bool | hasContent() const |
Señal del notificador:
| void | hasContentChanged() |
Véase también QWaylandSurface::bufferSize.
[read-only] inhibitsIdle : bool
Esta propiedad determina si esta superficie está pensada para impedir el comportamiento en reposo del compositor, como el apagado de la pantalla, el bloqueo y el salvapantallas.
Funciones de acceso:
| bool | inhibitsIdle() const |
Señal de notificación:
| void | inhibitsIdleChanged() |
Véase también QWaylandIdleInhibitManagerV1.
[read-only, since 6.4] isOpaque : bool
Esta propiedad se mantiene independientemente de que la superficie sea totalmente opaca, tal y como indica el cliente mediante la solicitud set_opaque_region.
Esta enumeración se introdujo en Qt 6.4.
Funciones de acceso:
| bool | isOpaque() const |
Señal de notificador:
| void | isOpaqueChanged() |
[read-only] origin : QWaylandSurface::Origin
Esta propiedad contiene el origen del búfer de la superficie « QWaylandSurface », o « QWaylandSurface::OriginTopLeft » si la superficie no tiene búfer.
Funciones de acceso:
| QWaylandSurface::Origin | origin() const |
Señal de notificación:
| void | originChanged() |
[read-only] sourceGeometry : QRectF
Esta propiedad describe la parte del QWaylandBuffer asociado que debe dibujarse en la pantalla. Las coordenadas se miden desde la esquina del búfer y se escalan mediante ` bufferScale`.
Funciones de acceso:
| QRectF | sourceGeometry() const |
Señal de notificador:
| void | sourceGeometryChanged() |
Véase también bufferScale, bufferSize y destinationSize.
Documentación de las funciones miembro
QWaylandSurface::QWaylandSurface()
Crea un objeto `QWaylandSurface` sin inicializar.
QWaylandSurface::QWaylandSurface(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version)
Crea e inicializa un objeto `QWaylandSurface` para los valores proporcionados en ` compositor ` y ` client`, y con los valores proporcionados en ` id ` y ` version`.
[override virtual noexcept] QWaylandSurface::~QWaylandSurface()
Destruye la « QWaylandSurface ».
[signal] void QWaylandSurface::childAdded(QWaylandSurface *child)
Esta señal se emite cuando se ha añadido una «wl_subsurface», « child », a la superficie.
QWaylandCompositor *QWaylandSurface::compositor() const
Devuelve el compositor de este QWaylandSurface.
[invokable] void QWaylandSurface::destroy()
Elimina el objeto « QWaylandSurface ».
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
[signal] void QWaylandSurface::dragStarted(QWaylandDrag *drag)
Esta señal se emite cuando un « drag » ha despegado desde esta pista.
[invokable] void QWaylandSurface::frameStarted()
Prepara todas las funciones de llamada de retorno de los fotogramas para su envío.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
[static] QWaylandSurface *QWaylandSurface::fromResource(wl_resource *resource)
Devuelve el objeto ` QWaylandSurface ` correspondiente al recurso de Wayland ` resource`.
[invokable] void QWaylandSurface::initialize(QWaylandCompositor *compositor, QWaylandClient *client, uint id, int version)
Inicializa el ` QWaylandSurface ` con los valores ` compositor ` y ` client` proporcionados, así como con los valores ` id ` y ` version` proporcionados.
Nota: Esta función puede invocarse a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
bool QWaylandSurface::inputRegionContains(const QPoint &p) const
Devuelve « true » si la región de entrada de « QWaylandSurface » contiene el punto « p ». En caso contrario, devuelve « false ».
bool QWaylandSurface::inputRegionContains(const QPointF &position) const
Devuelve ` true ` si la región de entrada de ` QWaylandSurface` contiene el punto ` position`. En caso contrario, devuelve ` false`.
[invokable] bool QWaylandSurface::isDestroyed() const
Devuelve «true» si se ha destruido el objeto QWaylandSurface. En caso contrario, devuelve «false».
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
bool QWaylandSurface::isInitialized() const
Devuelve «true» si se ha inicializado el objeto « QWaylandSurface ».
QWaylandView *QWaylandSurface::primaryView() const
Devuelve la vista principal de este QWaylandSurface.
Véase también QWaylandView::advance() y QWaylandSurface::setPrimaryView().
struct wl_resource *QWaylandSurface::resource() const
Devuelve el recurso de Wayland correspondiente a este QWaylandSurface.
[invokable] void QWaylandSurface::sendFrameCallbacks()
Envía las llamadas de retorno de los fotogramas pendientes.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
void QWaylandSurface::setPrimaryView(QWaylandView *view)
Establece la vista principal de esta QWaylandSurface como view, en caso de que haya varias vistas de esta superficie. La vista principal es la que determina la frecuencia de actualización del cliente. Se encarga de descartar las referencias al búfer cuando se llama a QWaylandView::advance(). Consulta la documentación de QWaylandView::advance() para obtener más detalles.
En las integraciones de superficie de shell, como QWaylandWlShellIntegration y QWaylandXdgShellV5Integration, las solicitudes de maximizar y de pantalla completa procedentes del cliente solo surtirán efecto si la integración tiene la vista principal de la superficie.
Véanse también primaryView() y QWaylandView::advance().
bool QWaylandSurface::setRole(QWaylandSurfaceRole *role, wl_resource *errorResource, uint32_t errorCode)
Establece un « role » en la superficie. Un rol define cómo se representará una superficie en pantalla; sin un rol, se supone que la superficie debe permanecer oculta. Una vez asignado un rol a una superficie, este pasa a ser su rol permanente. Cualquier llamada posterior a setRole() con un rol diferente provocará un error de protocolo en el errorResource y enviará un errorCode al cliente. El objetivo principal del rol de superficie es garantizar el cumplimiento de este requisito.
La función « role » compara los valores de los punteros. Cualquier par de objetos de « QWaylandSurfaceRole » se considerará que tienen funciones diferentes, independientemente de sus nombres.
El rol de superficie lo establecen internamente las implementaciones de protocolo cuando se adopta una superficie para un fin específico, por ejemplo, en una extensión de shell. A menos que estés desarrollando extensiones que utilicen superficies de esta manera, no debes llamar a esta función.
Devuelve «true» si se puede asignar un rol; «false» en caso contrario.
[signal] void QWaylandSurface::surfaceDestroyed()
Esta señal se emite cuando se destruye la wl_surface correspondiente.
[slot] void QWaylandSurface::updateSelection()
Actualiza la superficie con la selección del portapapeles que conserva el compositor. Aunque esto se realiza automáticamente cuando la superficie recibe el foco del teclado, esta función resulta útil para actualizar los clientes que no tienen el foco del teclado.
QList<QWaylandView *> QWaylandSurface::views() const
Devuelve las vistas correspondientes a este QWaylandSurface.
wl_client *QWaylandSurface::waylandClient() const
Soporta el « wl_client » mediante este enlace: QWaylandSurface.
© 2026 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.