summaryrefslogtreecommitdiff
path: root/opcodes/flsetcolor.xml
blob: dd51267223cb7054009a89d63b8f82728380dea8 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<refentry id="FLsetColor">
<indexterm id="IndexFLsetColor"><primary>FLsetColor</primary></indexterm>
  <refentryinfo><title>FLTK:Appearance</title></refentryinfo>
  <refmeta>
    <refentrytitle>FLsetColor</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>FLsetColor</refname>
    <refpurpose>
      Sets the primary color of a FLTK widget.
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>FLsetColor</emphasis> sets the primary color of the target widget.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>FLsetColor</command> ired, igreen, iblue, ihandle</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ired</emphasis> -- The red color of the target widget. The range for each RGB component is 0-255
    </para>

    <para>
      <emphasis>igreen</emphasis> -- The green color of the target widget. The range for each RGB component is 0-255
    </para>

    <para>
      <emphasis>iblue</emphasis> -- The blue color of the target widget. The range for each RGB component is 0-255
    </para>

    <para>
      <emphasis>ihandle</emphasis> -- an integer number (used as unique identifier) taken from the output of a previously located widget opcode (which corresponds to the target widget). It is used to unequivocally identify the widget when modifying its appearance with this class of opcodes. The user must not set the <emphasis>ihandle</emphasis> value directly, otherwise a Csound crash will occur.
    </para>
  </refsect1>

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

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

  <refsect1>
    <title>See Also</title>
    <para>
        <link linkend="FLcolor2"><citetitle>FLcolor2</citetitle></link>, 
        <link linkend="FLhide"><citetitle>FLhide</citetitle></link>, 
        <link linkend="FLlabel"><citetitle>FLlabel</citetitle></link>, 
        <link linkend="FLsetAlign"><citetitle>FLsetAlign</citetitle></link>, 
        <link linkend="FLsetBox"><citetitle>FLsetBox</citetitle></link>, 
        <link linkend="FLsetColor"><citetitle>FLsetColor</citetitle></link>, 
        <link linkend="FLsetColor2"><citetitle>FLsetColor2</citetitle></link>, 
        <link linkend="FLsetFont"><citetitle>FLsetFont</citetitle></link>, 
        <link linkend="FLsetPosition"><citetitle>FLsetPosition</citetitle></link>, 
        <link linkend="FLsetSize"><citetitle>FLsetSize</citetitle></link>, 
        <link linkend="FLsetText"><citetitle>FLsetText</citetitle></link>, 
        <link linkend="FLsetTextColor"><citetitle>FLsetTextColor</citetitle></link>, 
        <link linkend="FLsetTextSize"><citetitle>FLsetTextSize</citetitle></link>, 
        <link linkend="FLsetTextType"><citetitle>FLsetTextType</citetitle></link>, 
        <link linkend="FLsetVal_i"><citetitle>FLsetVal_i</citetitle></link>, 
        <link linkend="FLsetVal"><citetitle>FLsetVal</citetitle></link>, 
        <link linkend="FLshow"><citetitle>FLshow</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in version 4.22</para>
    <para>Example written by Iain McCurdy, edited by &namekevin;.</para>
  </refsect1>
</refentry>