Update a function comment about its input

2016-11-16 22:04:16 -08:00
parent b743bc1c1b
commit caead294f2
1 changed files with 2 additions and 1 deletions
@@ -42,7 +42,8 @@ typedef struct Uhj2Encoder {
 } Uhj2Encoder;

 /* Encodes a 2-channel UHJ (stereo-compatible) signal from a B-Format input
- * signal. */
+ * signal. The input must use FuMa channel ordering and scaling.
+ */
 void EncodeUhj2(Uhj2Encoder *enc, ALfloat *restrict LeftOut, ALfloat *restrict RightOut, ALfloat (*restrict InSamples)[BUFFERSIZE], ALuint SamplesToDo);

 #endif /* UHJFILTER_H */