quakeforge/doc/surround-sound.dox
Bill Currie 6a7b316572 Put my text editing vim settings into the docs.
Vim's autoformating doesn't like our style of comments, so I have to force
it to do what I want. Having to set the appropriate options every time I
edit a file got to be a RPITA, so time to get the computer to do it for me
:)
2011-09-08 10:17:58 +09:00

18 lines
1.2 KiB
Text

//unfortunately, have to wrap the docs in a C comment for doxygen
// vim:tw=74:formatoptions-=l
/**
\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>
*/