diff options
Diffstat (limited to 'src/compositor/doc/src')
4 files changed, 206 insertions, 0 deletions
diff --git a/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc b/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc new file mode 100644 index 000000000..4b38c8613 --- /dev/null +++ b/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc @@ -0,0 +1,50 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module QtWaylandCompositor + \title Qt Wayland Compositor C++ Classes + \ingroup modules + \qtvariable waylandcompositor + + \brief Provides C++ classes for writing custom Wayland display servers. + + To include the definitions of the module's classes, use the following directive: + + \code + #include <QtWaylandCompositor> + \endcode + + To link against the module, add this line to your \l qmake \c .pro file: + + \code + QT += waylandcompositor + \endcode + + For more information about using these classes in your application, + see the \l{Qt Wayland Compositor} documentation. +*/ diff --git a/src/compositor/doc/src/qtwaylandcompositor-examples.qdoc b/src/compositor/doc/src/qtwaylandcompositor-examples.qdoc new file mode 100644 index 000000000..2b8511281 --- /dev/null +++ b/src/compositor/doc/src/qtwaylandcompositor-examples.qdoc @@ -0,0 +1,36 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \group qtwaylandcompositor-examples + \title Qt Wayland Compositor Examples + \brief Examples for the Qt Wayland Compositor module + + These are the Qt Wayland Compositor examples. + +*/ + diff --git a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc new file mode 100644 index 000000000..9811d5205 --- /dev/null +++ b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc @@ -0,0 +1,68 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtwaylandcompositor-index.html + \title Qt Wayland Compositor + \brief An API to develop display servers supporting the Wayland protocol + + Qt Wayland Compositor is a module consisting of QML and C++ APIs for developing + custom display servers based on the \l{http://wayland.freedesktop.org}{Wayland protocol}. + The server displays content from client applications that support the Wayland protocol. + + \section1 Environment Variables and Command-line Arguments + + The Qt Wayland Compositor API recognizes some environment variables and command-line arguments + that can be used to customize its behavior. + + The environment variables: + \list + \li QT_WAYLAND_HARDWARE_INTEGRATION Selects which hardware integration plugin to use. + \li QT_WAYLAND_CLIENT_BUFFER_INTEGRATION Selects which client buffer integration plugin to use. + \li QT_WAYLAND_SERVER_BUFFER_INTEGRATION Selects which server integration plugin to use. + \endlist + + The command-line arguments: + \list + \li --wayland-socket-name Overrides the default socket name used for communicating with clients. + \endlist + + \section1 Examples + + Take a look at the \l{Qt Wayland Compositor Examples} for a demonstration on + how the APIs can be used to write custom display servers. + + \section1 API Reference + + The Qt Wayland Compositor API can be used from C++ or QML. + + \list + \li \l{Qt Wayland Compositor QML Types} + \li \l{Qt Wayland Compositor C++ Classes} + \endlist + +*/ diff --git a/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc b/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc new file mode 100644 index 000000000..ae8398735 --- /dev/null +++ b/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc @@ -0,0 +1,52 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmlmodule QtWayland.Compositor 1.0 + \title Qt Wayland Compositor QML Types + \ingroup qmlmodules + \brief Provides QML types for writing custom Wayland display servers. + + The Qt Wayland module provides QML types that can be used to create custom + display servers supporting the Wayland protocol. + + The QML types can be imported into your application using the following + import statement: + + \code + import QtWayland.Compositor 1.0 + \endcode + + To link against the module, add this line to your \l qmake \c .pro file: + + \code + QT += waylandcompositor + \endcode + + For more information about using these types in your application, + see the \l{Qt Wayland Compositor} documentation. +*/ |