Skip to content

Commit

Permalink
docs: Add behavior clarifications to Impulse help file.
Browse files Browse the repository at this point in the history
  • Loading branch information
mtmccrea committed Jul 18, 2022
1 parent dabf875 commit 1ac5cff
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions HelpSource/Classes/Impulse.schelp
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ categories:: UGens>Generators>Deterministic


Description::

Outputs non-bandlimited single sample impulses.


Expand All @@ -14,26 +13,25 @@ classmethods::
method::ar, kr

argument::freq

Frequency in Hertz.
Frequency in Hertz. strong::freq:: may be negative.


argument::phase

Phase offset in cycles (0..1).

Phase offset in cycles (0..1). Staying in this range offers a slight efficiency
advantage, though phase offsets outside this range are supported and wrapped
internally.

argument::mul

The output will be multiplied by this value.


argument::add

This value will be added to the output.

discussion::
An Impulse with frequency 0 returns a single impulse.
code::Impulse:: will output an impulse on the first sample (assuming no phase
offset). code::Impulse:: with strong::freq:: code::0:: outputs a single impulse,
followed by silence until the frequency changes.

Examples::

Expand Down

0 comments on commit 1ac5cff

Please sign in to comment.