clean up indentation and spacing
[supercollider.git] / HelpSource / Classes / InTrig.schelp
blob9c7bb16873a073d477de22294babc33213ab68f9
1 class:: InTrig
2 summary:: Generate a trigger anytime a bus is set.
3 categories::  UGens>InOut, UGens>Triggers
6 Description::
8 Any time the bus is "touched" ie. has its value set (using "/c_set"
9 etc.), a single impulse trigger will be generated. Its amplitude is the
10 value that the bus was set to.
12 If the bus is set link::Classes/Bus#synchronous_control_bus_methods#synchrounosly:: no trigger will be generated.
15 classmethods::
17 method::kr
19 argument::bus
20 The index of the bus to read in from.
22 argument::numChannels
23 The number of channels (i.e. adjacent buses) to read in. You
24 cannot modulate this number by assigning it to an argument in a
25 SynthDef.
28 Examples::
30 code::
31 s = Server.local;
32 b = Bus.control(s,1);
34 SynthDef("help-InTrig",{arg out=0,busnum=0;
35         var inTrig;
36         inTrig = InTrig.kr( busnum );
37         Out.ar(out,
38                 EnvGen.kr(Env.perc,gate: inTrig,levelScale: inTrig ) * SinOsc.ar
39         )
40 }).play(s,[\out, 0, \busnum, b.index]);
43 b.set(1.0);
45 b.value = 1.0;
47 b.value = 0.2;
49 b.value = 0.1;
52 compare with link::Classes/In:: example.