diff options
| author | Lars Knoll <lars.knoll@qt.io> | 2022-05-04 14:36:20 +0200 |
|---|---|---|
| committer | Lars Knoll <lars.knoll@qt.io> | 2022-05-11 08:24:19 +0200 |
| commit | ad99bd3998face1590944e5a82af5ffc90482eb4 (patch) | |
| tree | ac0c39a0a925bfc95c4cdaaed93628f298b2ceda /src/multimediaquick3d | |
| parent | 6b4126e3d142ce1c056bc07a394eecbc1d4a2746 (diff) | |
Add overview and example docs for spatial audio
Add a short description of the spatialaudio example and some
overview docs for that part of the API.
Change-Id: I7ee7b61c00f82f3bd4ca438e96b01a7c5e9889ff
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Diffstat (limited to 'src/multimediaquick3d')
5 files changed, 6 insertions, 1 deletions
diff --git a/src/multimediaquick3d/qquick3dspatialaudioengine.cpp b/src/multimediaquick3d/qquick3dspatialaudioengine.cpp index f167d04fd..ebaff35cb 100644 --- a/src/multimediaquick3d/qquick3dspatialaudioengine.cpp +++ b/src/multimediaquick3d/qquick3dspatialaudioengine.cpp @@ -44,6 +44,7 @@ static QSpatialAudioEngine *globalEngine = nullptr; /*! \qmltype SpatialAudioEngine \inqmlmodule QtQuick3D.SpatialAudio + \ingroup quick3d_spatialaudio \brief SpatialAudioEngine manages sound objects inside a 3D scene. diff --git a/src/multimediaquick3d/qquick3dspatialaudiolistener.cpp b/src/multimediaquick3d/qquick3dspatialaudiolistener.cpp index de58066f2..98dc0fd45 100644 --- a/src/multimediaquick3d/qquick3dspatialaudiolistener.cpp +++ b/src/multimediaquick3d/qquick3dspatialaudiolistener.cpp @@ -43,6 +43,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype SpatialAudioListener \inqmlmodule QtQuick3D.SpatialAudio + \ingroup quick3d_spatialaudio \brief defines the position and orientation of the person listening to a sound field defined by a SpatialAudioEngine. diff --git a/src/multimediaquick3d/qquick3dspatialaudioroom.cpp b/src/multimediaquick3d/qquick3dspatialaudioroom.cpp index 74b1cf1c5..5782a0ab8 100644 --- a/src/multimediaquick3d/qquick3dspatialaudioroom.cpp +++ b/src/multimediaquick3d/qquick3dspatialaudioroom.cpp @@ -43,6 +43,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype SpatialAudioRoom \inqmlmodule QtQuick3D.SpatialAudio + \ingroup quick3d_spatialaudio Defines a room for the spatial audio engine. @@ -111,7 +112,7 @@ QVector3D QQuick3DSpatialAudioRoom::dimensions() const \li Coordinate \row \li left \li Negative x \row \li right \li Positive x - \row \li back \li Negative x + \row \li back \li Negative z \row \li front \li Positive z \row \li floor \li Negative y \row \li ceiling \li Positive y diff --git a/src/multimediaquick3d/qquick3dspatialaudiosoundsource.cpp b/src/multimediaquick3d/qquick3dspatialaudiosoundsource.cpp index 1e41f26e8..ff2fdebf4 100644 --- a/src/multimediaquick3d/qquick3dspatialaudiosoundsource.cpp +++ b/src/multimediaquick3d/qquick3dspatialaudiosoundsource.cpp @@ -45,6 +45,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype SpatialAudioSoundSource \inqmlmodule QtQuick3D.SpatialAudio + \ingroup quick3d_spatialaudio \brief A sound object in 3D space. diff --git a/src/multimediaquick3d/qquick3dspatialaudiostereosource.cpp b/src/multimediaquick3d/qquick3dspatialaudiostereosource.cpp index 3bfc9b125..55efde12a 100644 --- a/src/multimediaquick3d/qquick3dspatialaudiostereosource.cpp +++ b/src/multimediaquick3d/qquick3dspatialaudiostereosource.cpp @@ -45,6 +45,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype SpatialAudioStereoSource \inqmlmodule QtQuick3D.SpatialAudio + \ingroup quick3d_spatialaudio \brief A stereo overlay sound. |