Added help for Pen and updated some other docs
[supercollider.git] / HelpSource / Classes / Impulse.schelp
blobf510ec078563f0a979a71d8a53af959fcfe78ce1
1 class:: Impulse
2 summary:: Impulse oscillator.
3 related:: Classes/Blip
4 categories::  UGens>Generators>Deterministic
7 Description::
9 Outputs non-bandlimited single sample impulses.
12 classmethods::
14 method::ar, kr
16 argument::freq
18 Frequency in Hertz.
21 argument::phase
23 Phase offset in cycles (0..1).
26 argument::mul
28 Output will be multiplied by this value.
31 argument::add
33 This value will be added to the output.
35 discussion::
36 An Impulse with frequency 0 returns a single impulse.
38 Examples::
40 code::
41 { Impulse.ar(800, 0.0, 0.5, 0) }.play
43 { Impulse.ar(XLine.kr(800,100,5), 0.0,  0.5, 0) }.play
46 modulate phase:
47 code::
48 { Impulse.ar(4, [0, MouseX.kr(0, 1)], 0.2) }.play;
51 an Impulse with frequency 0 returns a single impulse:
52 code::
53 SynthDef(\imp, { OffsetOut.ar(0, Impulse.ar(0)); FreeSelf.kr(Impulse.kr(0)); }).add;
54 fork { (1 / (1..60).scramble).do { |dt| Synth.grain(\imp);  dt.wait } };