Added help for Pen and updated some other docs
[supercollider.git] / HelpSource / Classes / PanB2.schelp
blobaff3c4db474095bc6efdb1354e78d922d5f185b0
1 class:: PanB2
2 summary:: 2D Ambisonic B-format panner.
3 related:: Classes/BiPanB2, Classes/DecodeB2, Classes/PanB, Classes/Rotate2
4 categories::  UGens>Multichannel>Ambisonics
7 Description::
9 Encodes a mono signal to 2-dimensional ambisonic B-format.
12 classmethods::
14 method::ar, kr
16 argument::in
18 The input signal.
21 argument::azimuth
23 Position around the circle from -1 to +1. -1 is behind, -0.5 is
24 left, 0 is forward, +0.5 is right, +1 is behind.
27 argument::gain
29 Amplitude control.
32 Examples::
34 code::
38         var w, x, y, p, a, b, c, d;
40         p = PinkNoise.ar; // source
42         // B-format encode
43         #w, x, y = PanB2.ar(p, MouseX.kr(-1,1), 0.1);
45         // B-format decode to quad
46         #a, b, c, d = DecodeB2.ar(4, w, x, y);
48         [a, b, d, c] // reorder to my speaker arrangement: Lf Rf Lr Rr
49 }.play;