Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / Decay2.schelp
blob4831c5a36127e57c682b3afc0d361886e0fab1eb
1 class:: Decay2
2 summary:: Exponential decay
3 related:: Classes/Decay
4 categories::  UGens>Filters>Linear, UGens>Envelopes
7 Description::
8 link::Classes/Decay::  has a very sharp attack and can produce clicks.
9 Decay2 rounds off the attack by subtracting one Decay from another.
10 code:: Decay2.ar(in, attackTime, decayTime):: is equivalent to:
12 code::
13 Decay.ar(in, decayTime) - Decay.ar(in, attackTime)
17 classmethods::
19 method::ar, kr
21 argument::in
23 The input signal.
26 argument::attackTime
28 60 dB attack time in seconds.
31 argument::decayTime
33 60 dB decay time in seconds.
36 argument::mul
38 argument::add
41 Examples::
43 code::
44 // since attack and decay are a difference of two Decays,
45 // swapping the values, the envelope turns upside down:
46 plot({ Decay2.ar(Impulse.ar(1), 0.001, 0.01) })
47 plot({ Decay2.ar(Impulse.ar(1), 0.01, 0.001) })
49 // used as an envelope
50 { Decay2.ar(Impulse.ar(XLine.kr(1,50,20), 0.25), 0.01, 0.2, FSinOsc.ar(600)) }.play;
52 // compare the above with Decay used as the envelope
53 { Decay.ar(Impulse.ar(XLine.kr(1,50,20), 0.25), 0.2, FSinOsc.ar(600), 0)  }.play;