1// Copyright (C) 2024 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
5\page qt-generate-wayland-protocol-client-sources.html
6\ingroup cmake-commands-qtwaylandclient
8\title qt_generate_wayland_protocol_client_sources
9\keyword qt6_generate_wayland_protocol_client_sources
11\summary {Generates client-side C++ bindings for a Wayland protocol .XML file}
15The command is defined in the \c WaylandClient component of the \c Qt6 package, which
19find_package(Qt6 REQUIRED COMPONENTS WaylandClient)
25qt_generate_wayland_protocol_client_sources(target
26 [PUBLIC_CODE | PRIVATE_CODE]
27 FILES file1.xml [file2.xml ...])
30\versionlessCMakeCommandsNote qt6_generate_wayland_protocol_client_sources()
34qt_generate_wayland_protocol_client_sources() creates the build steps to run \c{wayland-scanner} and
35\c{qtwaylandscanner} on one or more Wayland protocol files. The tools will in turn generate binding
36code in C and C++ for implementing the protocols, and the resulting files will be built as part
39The options \c{PUBLIC_CODE} and \c{PRIVATE_CODE} correspond to the \c{public-code} and
40\c{private-code} options of \c{wayland-scanner}. \c{PUBLIC_CODE} will cause the symbols in the
41code that is generated by \c{wayland-scanner} to be exported. For backwards compatibility \c{PUBLIC_CODE} is the
42default but generally \c{PRIVATE_CODE} is strongly recommended.
44qt_generate_wayland_protocol_client_sources() will trigger generation of the files needed to
45implement the client side of the protocol. \l{qt_generate_wayland_protocol_server_sources}{qt_generate_wayland_protocol_server_sources()}
46is the equivalent function for the compositor.
48See the \l{Custom Shell} or \l{Custom Extension} examples for a demonstration of how to use these