En esta página

QWaylandCompositor Class

La clase QWaylandCompositor gestiona el servidor de pantalla Wayland. Más información...

Encabezado: #include <QWaylandCompositor>
CMake: find_package(Qt6 REQUIRED COMPONENTS WaylandCompositor)
target_link_libraries(mytarget PRIVATE Qt6::WaylandCompositor)
qmake: QT += waylandcompositor
En QML: WaylandCompositor
Heredado de: QWaylandObject

Propiedades

Funciones públicas

QWaylandCompositor(QObject *parent = nullptr)
virtual ~QWaylandCompositor() override
void addSocketDescriptor(int fd)
QVector<QWaylandCompositor::ShmFormat> additionalShmFormats() const
virtual void create()
QWaylandOutput *defaultOutput() const
QWaylandSeat *defaultSeat() const
void destroyClient(QWaylandClient *client)
void destroyClientForSurface(QWaylandSurface *surface)
virtual void grabSurface(QWaylandSurfaceGrabber *grabber, const QWaylandBufferRef &buffer)
bool isCreated() const
QWaylandOutput *outputFor(QWindow *window) const
bool retainedSelectionEnabled() const
QWaylandSeat *seatFor(QInputEvent *inputEvent)
void setAdditionalShmFormats(const QVector<QWaylandCompositor::ShmFormat> &additionalShmFormats)
void setDefaultOutput(QWaylandOutput *output)
void setRetainedSelectionEnabled(bool enabled)
void setSocketName(const QByteArray &name)
void setUseHardwareIntegrationExtension(bool use)
QByteArray socketName() const
bool useHardwareIntegrationExtension() const

Señales

void additionalShmFormatsChanged()
void createdChanged()
void defaultOutputChanged()
void defaultSeatChanged(QWaylandSeat *newDevice, QWaylandSeat *oldDevice)
void retainedSelectionChanged(bool retainedSelection)
void socketNameChanged(const QByteArray &socketName)
void surfaceCreated(QWaylandSurface *surface)
void surfaceRequested(QWaylandClient *client, uint id, int version)
void useHardwareIntegrationExtensionChanged()

Descripción detallada

QWaylandCompositor gestiona las conexiones con los clientes, así como los distintos outputs y seats.

Normalmente, una aplicación compositora tendrá una única instancia de ` WaylandCompositor `, que puede tener varias salidas como elementos secundarios.

Documentación de propiedades

[since 6.0] additionalShmFormats : QVector<ShmFormat>

Esta propiedad contiene la lista de formatos wl_shm adicionales que el compositor indica que admite.

Por defecto, solo aparecen los formatos obligatorios ShmFormat_ARGB8888 y ShmFormat_XRGB8888, por lo que esta lista estará vacía.

Esta propiedad debe configurarse antes de que el compositor se created. Los cambios posteriores no tendrán ningún efecto.

Esta enumeración se introdujo en Qt 6.0.

Funciones de acceso:

QVector<QWaylandCompositor::ShmFormat> additionalShmFormats() const
void setAdditionalShmFormats(const QVector<QWaylandCompositor::ShmFormat> &additionalShmFormats)

Señal de notificador:

void additionalShmFormatsChanged()

[read-only] created : bool

Esta propiedad es verdadera si se ha inicializado ` QWaylandCompositor `; en caso contrario, es falsa.

Funciones de acceso:

bool isCreated() const

Señal del notificador:

void createdChanged()

defaultOutput : QWaylandOutput*

Esta propiedad contiene la primera salida de la lista añadida a QWaylandCompositor, o el valor nulo si no se ha añadido ninguna salida.

Al establecer una nueva salida predeterminada, esta se añade al principio de la lista de salidas, convirtiéndose en la nueva predeterminada, pero la salida predeterminada anterior no se elimina de la lista. Si la nueva salida predeterminada ya figuraba en la lista de salidas, se desplaza al principio de la misma.

Funciones de acceso:

QWaylandOutput *defaultOutput() const
void setDefaultOutput(QWaylandOutput *output)

Señal de notificación:

void defaultOutputChanged()

[read-only] defaultSeat : QWaylandSeat*

Esta propiedad contiene el asiento predeterminado para este QWaylandCompositor.

Funciones de acceso:

QWaylandSeat *defaultSeat() const

Señal de notificación:

void defaultSeatChanged(QWaylandSeat *newDevice, QWaylandSeat *oldDevice)

retainedSelection : bool

Esta propiedad controla si el compositor conserva una copia de los datos seleccionados en el portapapeles. Cuando se establece en « true », el compositor lee de forma proactiva y almacena en caché todos los datos del portapapeles procedentes del cliente propietario. Esto conlleva un coste de rendimiento. El valor por defecto es « false ».

Funciones de acceso:

bool retainedSelectionEnabled() const
void setRetainedSelectionEnabled(bool enabled)

Señal de notificador:

void retainedSelectionChanged(bool retainedSelection)

Véanse también QWaylandCompositor ::retainedSelectionReceived() y QWaylandSurface::updateSelection().

socketName : QByteArray

Esta propiedad contiene el nombre del socket que utiliza QWaylandCompositor para comunicarse con los clientes. Debe configurarse antes de que QWaylandCompositor sea created.

Si socketName está vacío (valor por defecto), se utiliza en su lugar el contenido del argumento start de --wayland-socket-name. Si el argumento no está definido, el compositor intenta encontrar un nombre de socket, que por defecto es wayland-0.

Funciones de acceso:

QByteArray socketName() const
void setSocketName(const QByteArray &name)

Señal del notificador:

void socketNameChanged(const QByteArray &socketName)

useHardwareIntegrationExtension : bool

Esta propiedad determina si la extensión de integración de hardware debe estar habilitada para este QWaylandCompositor.

Esta propiedad debe configurarse antes de que el compositor sea created.

Funciones de acceso:

bool useHardwareIntegrationExtension() const
void setUseHardwareIntegrationExtension(bool use)

Señal de notificador:

void useHardwareIntegrationExtensionChanged()

Documentación de la función miembro

QWaylandCompositor::QWaylandCompositor(QObject *parent = nullptr)

Crea un objeto `QWaylandCompositor` con el ` parent` indicado.

[override virtual noexcept] QWaylandCompositor::~QWaylandCompositor()

Destruye el QWaylandCompositor

[invokable] void QWaylandCompositor::addSocketDescriptor(int fd)

Escucha las conexiones de los clientes en un descriptor de archivo, fd, que hace referencia a un socket de servidor ya vinculado y en modo de escucha.

No toma posesión del descriptor de archivo; debe cerrarse explícitamente si es necesario.

Nota: Este método solo está disponible con libwayland 1.10.0 o posterior. Si se compila con un tiempo de ejecución de libwayland anterior, este método no realiza ninguna acción.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

[virtual] void QWaylandCompositor::create()

Inicializa el objeto ` QWaylandCompositor`. Si sobrescribes esta función en tu subclase, asegúrate de llamar a la implementación de la clase base.

[invokable] void QWaylandCompositor::destroyClient(QWaylandClient *client)

Elimina el objeto « client ».

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

[invokable] void QWaylandCompositor::destroyClientForSurface(QWaylandSurface *surface)

Elimina el cliente de surface.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

[virtual] void QWaylandCompositor::grabSurface(QWaylandSurfaceGrabber *grabber, const QWaylandBufferRef &buffer)

Obtiene el contenido de la superficie a partir de la dirección buffer proporcionada. Para que funcione, la implementación predeterminada requiere que haya un contexto de OpenGL vinculado al hilo actual. Si esto no es posible, reimplementa esta función en tu subclase de compositor para implementar una lógica personalizada. La implementación predeterminada solo captura memoria compartida y búferes de OpenGL; reimplementa esto en tu subclase de compositor para gestionar más tipos de búferes.

Nota: Nodebes llamar a esta función manualmente, sino utilizar ` QWaylandSurfaceGrabber ` (grabber).

[invokable] QWaylandOutput *QWaylandCompositor::outputFor(QWindow *window) const

Devuelve el objeto « QWaylandOutput » conectado al « window » indicado.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

QWaylandSeat *QWaylandCompositor::seatFor(QInputEvent *inputEvent)

Selecciona el «seat» para un evento de entrada determinado inputEvent. Actualmente, Qt solo admite un único «seat».

[signal] void QWaylandCompositor::surfaceCreated(QWaylandSurface *surface)

Esta señal se emite cuando se ha creado una nueva instancia de QWaylandSurface surface .

[signal] void QWaylandCompositor::surfaceRequested(QWaylandClient *client, uint id, int version)

Esta señal se emite cuando un ` client ` ha creado una superficie con el identificador ` id`. También está disponible la interfaz ` version `.

La ranura conectada a esta señal puede crear e inicializar una instancia de QWaylandSurface dentro del ámbito de la ranura. De lo contrario, se crea una superficie por defecto.

Las conexiones a esta señal deben ser del tipo de conexión « Qt::DirectConnection ».

© 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.