summaryrefslogtreecommitdiffstats
path: root/src/spatialaudio/doc/src/qtspatialaudio-cpp.qdoc
blob: 558665e3afeedea8a527d47929b768efb641a2f8 (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
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \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}

*/