From 89d6e2ef11bb9c79a891c8ac51de6873b25cfe57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 1 Apr 2024 12:05:29 +0200 Subject: [PATCH] WavAudioImporter: put detailed format info later in the docs page. Similarly as with other plugins, so the user isn't overwhelmed with the details before even getting to know how to use the damn thing. --- .../WavAudioImporter/WavImporter.h | 34 ++++++++++--------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/src/MagnumPlugins/WavAudioImporter/WavImporter.h b/src/MagnumPlugins/WavAudioImporter/WavImporter.h index 3419f96d5..e8ed7446d 100644 --- a/src/MagnumPlugins/WavAudioImporter/WavImporter.h +++ b/src/MagnumPlugins/WavAudioImporter/WavImporter.h @@ -60,21 +60,7 @@ namespace Magnum { namespace Audio { @m_keywords{WavAudioImporter} -Supports mono and stereo files of the following formats: - -- 8 bit per channel PCM, imported as @ref BufferFormat::Mono8 and - @ref BufferFormat::Stereo8 -- 16 bit per channel PCM, imported as @ref BufferFormat::Mono16 and - @ref BufferFormat::Stereo16 -- 32-bit IEEE Float, imported as @ref BufferFormat::MonoFloat / - @ref BufferFormat::StereoFloat -- 64-bit IEEE Float, imported as @ref BufferFormat::MonoDouble / - @ref BufferFormat::StereoDouble -- A-Law, imported as @ref BufferFormat::MonoALaw / @ref BufferFormat::StereoALaw -- μ-Law, imported as @ref BufferFormat::MonoMuLaw / @ref BufferFormat::StereoMuLaw - -Both Little-Endian files (with a `RIFF` header) and Big-Endian files (with -a `RIFX` header) are supported, data is converted to machine endian on import. +Imports mono and stereo files. @section Audio-WavImporter-usage Usage @@ -112,7 +98,23 @@ target_link_libraries(your-app PRIVATE Magnum::WavAudioImporter) See @ref building, @ref cmake and @ref plugins for more information. -@section Audio-WavImporter-limitations Behavior and limitations +@section Audio-WavImporter-behavior Behavior and limitations + +Supports mono and stereo files of the following formats: + +- 8 bit per channel PCM, imported as @ref BufferFormat::Mono8 and + @ref BufferFormat::Stereo8 +- 16 bit per channel PCM, imported as @ref BufferFormat::Mono16 and + @ref BufferFormat::Stereo16 +- 32-bit IEEE Float, imported as @ref BufferFormat::MonoFloat / + @ref BufferFormat::StereoFloat +- 64-bit IEEE Float, imported as @ref BufferFormat::MonoDouble / + @ref BufferFormat::StereoDouble +- A-Law, imported as @ref BufferFormat::MonoALaw / @ref BufferFormat::StereoALaw +- μ-Law, imported as @ref BufferFormat::MonoMuLaw / @ref BufferFormat::StereoMuLaw + +Both Little-Endian files (with a `RIFF` header) and Big-Endian files (with +a `RIFX` header) are supported, data is converted to machine endian on import. Multi-channel formats are not supported. */