Skip to content

Commit

Permalink
added a note to oscil.xml about possible unexpected behaviour by Joac…
Browse files Browse the repository at this point in the history
…him Heintz
  • Loading branch information
fggp committed Dec 15, 2024
1 parent effe1eb commit 09011c1
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions opcodes/oscil.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<refnamediv>
<refname>oscil</refname>
<refpurpose>
A simple oscillator.
A simple oscillator without any interpolation.
</refpurpose>
</refnamediv>

Expand Down Expand Up @@ -57,8 +57,17 @@
<para>
If you need to change the oscillator table with a k-rate signal, you can use <link linkend="oscilikt"><citetitle>oscilikt</citetitle></link>.
</para>

</refsect1>
<note>
<!-- <title>Title of the note (optional)</title> -->
<para>
This opcode does not perform any interpolation.
This can lead to unexpected behaviour or unclean signals,
e.g. for small table sizes and low frequencies.
As standard oscillators the usage of <link linkend="oscili"><citetitle>oscili</citetitle></link>
or <link linkend="poscil"><citetitle>poscil</citetitle></link> is recommended.
</para>
</note>
</refsect1>

<refsect1>
<title>Examples</title>
Expand Down

0 comments on commit 09011c1

Please sign in to comment.