From 6c3362497b735063486a045cef1951633cb081e3 Mon Sep 17 00:00:00 2001
From: Joseph Walton-Rivers <joseph@walton-rivers.uk>
Date: Wed, 21 Jun 2023 06:57:18 +0100
Subject: [PATCH] document both audio module options
---
include/fggl/audio/null_audio.hpp | 1 +
include/fggl/audio/openal/module.hpp | 1 +
2 files changed, 2 insertions(+)
diff --git a/include/fggl/audio/null_audio.hpp b/include/fggl/audio/null_audio.hpp
index fbcd9b3..4d14b27 100644
--- a/include/fggl/audio/null_audio.hpp
+++ b/include/fggl/audio/null_audio.hpp
@@ -37,6 +37,7 @@ namespace fggl::audio {
void play(const AudioClipShort & /*clip*/, bool /*looping = false*/) override;
};
+ //! A dummy audio module that does nothing
struct NullAudio {
constexpr static const char *name = "fggl::audio::NULL";
constexpr static const std::array<modules::ServiceName, 1> provides = {
diff --git a/include/fggl/audio/openal/module.hpp b/include/fggl/audio/openal/module.hpp
index 28e6d1f..d6236ed 100644
--- a/include/fggl/audio/openal/module.hpp
+++ b/include/fggl/audio/openal/module.hpp
@@ -33,6 +33,7 @@ namespace fggl::audio {
constexpr auto OGG_VORBIS = assets::AssetType::make("audio/vorbis");
constexpr auto RES_OGG_VORBIS = assets::from_mime("audio/vorbis");
+ //! an audio module which uses openal(-soft) as a backend.
struct OpenAL {
constexpr static const char *name = "fggl::audio::OpenAL";
constexpr static const std::array<modules::ServiceName, 1> provides = {
--
GitLab