mirror of
https://git.code.sf.net/p/quake/quakeforge
synced 2024-11-10 15:22:04 +00:00
605d60167d
So I don't have to keep duplicating file names all over the place, I've decided to use the "dox" extension on text files that are formatted for doxygen processing. This way, doxygen can search for them using wildcards, and unformated text files won't cause any headaches.
17 lines
1.2 KiB
Text
17 lines
1.2 KiB
Text
//unfortunately, have to wrap the docs in a C comment for doxygen
|
|
/**
|
|
\page surround_sound_spec Description of Surround-Sound Channels
|
|
|
|
Swiped from the vorbis docs
|
|
<dl>
|
|
<dt>one channel</dt> <dd>the stream is monophonic</dd>
|
|
<dt>two channels</dt> <dd>the stream is stereo. channel order: left, right</dd>
|
|
<dt>three channels</dt> <dd>the stream is a 1d-surround encoding. channel order: left, center, right</dd>
|
|
<dt>four channels</dt> <dd>the stream is quadraphonic surround. channel order: front left, front right, rear left, rear right</dd>
|
|
<dt>five channels</dt> <dd>the stream is five-channel surround. channel order: front left, center, front right, rear left, rear right</dd>
|
|
<dt>six channels</dt> <dd>the stream is 5.1 surround. channel order: front left, center, front right, rear left, rear right, LFE</dd>
|
|
<dt>seven channels</dt> <dd>the stream is 6.1 surround. channel order: front left, center, front right, side left, side right, rear center, LFE</dd>
|
|
<dt>eight channels</dt> <dd>the stream is 7.1 surround. channel order: front left, center, front right, side left, side right, rear left, rear right, LFE</dd>
|
|
<dt>greater than eight channels</dt> <dd>channel use and order is undefined </dd>
|
|
</dl>
|
|
*/
|