summaryrefslogtreecommitdiff
path: root/opcodes/lineto.xml
blob: 5d8dd5b3eb63ad8ea30e02743ccb8a778bc29c2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<refentry id="lineto">
<indexterm id="IndexLineto"><primary>lineto</primary></indexterm>
  <refentryinfo><title>Signal Modifiers:Standard Filters:Control</title></refentryinfo>
  <refmeta>
    <refentrytitle>lineto</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>lineto</refname>
    <refpurpose>
      Generate glissandos starting from a control signal.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Generate glissandos starting from a control signal.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>kres <command>lineto</command> ksig, ktime</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kres</emphasis> -- Output signal.
    </para>

    <para>
      <emphasis>ksig</emphasis> -- Input signal.
    </para>

    <para>
      <emphasis>ktime</emphasis> -- Time length of glissando in seconds.
    </para>

    <para>
      <emphasis>lineto</emphasis> adds glissando (i.e. straight lines) to a stepped input signal (for example, produced by <link linkend="randh"><citetitle>randh</citetitle></link> or <link linkend="lpshold"><citetitle>lpshold</citetitle></link>).  It generates a straight line starting from previous step value, reaching the new step value in <emphasis>ktime</emphasis> seconds. When the new step value is reached, such value is held until a new step occurs. Be sure that <emphasis>ktime</emphasis> argument value is smaller than the time elapsed between two consecutive steps of the original signal, otherwise discontinuities will occur in output signal.
    </para>

    <para>
      When used together with the output of <link linkend="lpshold"><citetitle>lpshold</citetitle></link> it emulates the glissando effect of old analog sequencers.
    </para>
    <note><para>No new value for <emphasis>ksig</emphasis> or <emphasis>ktime</emphasis> will have effect until the previous <emphasis>ktime</emphasis> has elapsed.</para></note>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the lineto opcode. It uses the file <ulink url="examples/lineto.csd"><citetitle>lineto.csd</citetitle></ulink>.
      <example>
        <title>Example of the lineto opcode.</title>
        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/lineto.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="tlineto"><citetitle>tlineto</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in Version 4.13</para>
  </refsect1>
</refentry>