summaryrefslogtreecommitdiff
path: root/opcodes/flashtxt.xml
blob: 0cef243e3b06ed1c8373dd80e2cfd15b1216ab1e (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
<refentry id="flashtxt">
<indexterm id="IndexFlashtxt"><primary>flashtxt</primary></indexterm>
  <refentryinfo><title>Signal I/O:Printing and Display</title></refentryinfo>
  <refmeta>
    <refentrytitle>flashtxt</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>flashtxt</refname>
    <refpurpose>
      Allows text to be displayed from instruments like sliders
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Allows text to be displayed from instruments like sliders etc. (only on Unix and Windows at present)
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>flashtxt</command>  iwhich, String</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>iwhich</emphasis> -- the number of the window.
    </para>

    <para>
      <emphasis>String</emphasis> -- the string to be displayed.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      A window is created, identified by the iwhich argument, with the text string displayed.  If the text is replaced by a number then the window id deleted.  Note that the text windows are globally numbered so different instruments can change the text, and the window survives the instance of the instrument.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the flashtxt opcode. It uses the file <ulink url="examples/flashtxt.csd"><citetitle>flashtxt.csd</citetitle></ulink>.

      <example>
        <title>Example of the flashtxt 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/flashtxt.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
</refentry>