scide: LookupDialog - redo lookup on classes after partial lookup
[supercollider.git] / HelpSource / Classes / FSinOsc.schelp
bloba9154193ce1c9882920566e57d0648170ecc33f0
1 class:: FSinOsc
2 summary:: Fast sine oscillator.
3 related:: Classes/SinOsc, Classes/SinOscFB
4 categories::  UGens>Generators>Deterministic
6 Description::
8 Very fast sine wave generator (2 PowerPC instructions per output sample!)
9 implemented using a ringing filter. This generates a much cleaner sine
10 wave than a table lookup oscillator and is a lot faster. However, the
11 amplitude of the wave will vary with frequency. Generally the amplitude
12 will go down as you raise the frequency and go up as you lower the frequency.
14 warning::
15 In the current implementation, the amplitude can blow up if the
16 frequency is modulated by certain alternating signals.
20 classmethods::
22 method::ar, kr
24 argument::freq
25 Frequency in Hertz.
27 argument::iphase
28 Initial phase offset.
30 argument::mul
31 Output will be multiplied by this value.
33 argument::add
34 This value will be added to the output.
37 Examples::
39 code::
40 { FSinOsc.ar(800) * 0.2 }.play;
42 { FSinOsc.ar(XLine.kr(200, 4000, 1)) * 0.2 }.play;
44 // loses amplitude towards the end
45 { FSinOsc.ar(FSinOsc.ar(XLine.kr(4, 401, 8), 0.0, 200, 800)) * 0.2 }.play;