summaryrefslogtreecommitdiffstats
path: root/src/spatialaudio/doc/src/qtspatialaudio-cpp.qdoc
blob: fcf75ddc696bdac60e1c8d8c926ac362c516eca0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/****************************************************************************
**
** Copyright (C) 2022 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \module QtSpatialAudio
    \title Qt Spatial Audio Module C++ Classes
    \ingroup modules
    \qtvariable spatialaudio
    \qtcmakepackage SpatialAudio

    \brief The \l {Qt Spatial Audio} module provides functionality for 3D audio.

    To enable Qt Spatial Audio in a project, add this directive into your
    C++ files:

    \code
        #include <QtSpatialAudio>
    \endcode

    \include module-use.qdocinc using qt module

    \code
        find_package(Qt6 REQUIRED COMPONENTS SpatialAudio)
        target_link_libraries(my_project PRIVATE Qt6::SpatialAudio)
    \endcode
*/

/*!
    \page qtspatialaudio-modules.html
    \title Qt Spatial Audio C++ Classes
    \brief Provides C++ class for spatial audio use cases.

    The C++ classes provide the same functionality as the Qt Quick3D spatial audio
    module.

    \section1 Classes

    \generatelist {classesbymodule QtSpatialAudio}

*/