Browse Source

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.
pull/638/head
Vladimír Vondruš 2 years ago
parent
commit
89d6e2ef11
  1. 34
      src/MagnumPlugins/WavAudioImporter/WavImporter.h

34
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.
*/

Loading…
Cancel
Save