File: DoRGBaValue.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (69 lines) | stat: -rw-r--r-- 1,964 bytes parent folder | download | duplicates (7)
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
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
  SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
  <func>
    <title>DoRGBaValue</title>
    <category>Arithmetics</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>int</type>
          <name>Val</name>
          <desc>32 bit color value</desc>
        </param>
        <param>
          <type>int</type>
          <name>change</name>
          <desc>Color value to be added.</desc>
        </param>
        <param>
          <type>int</type>
          <name>select</name>
          <desc>0-3: Color value to be changed.</desc>
        </param>
      </params>
    </syntax>
    <desc>
      Adds a specified color value to a 32 bit color value. 
      <table>
        <rowh>
          <literal_col>select</literal_col>
          <col>Selection</col>
        </rowh>
        <row>
          <literal_col>0</literal_col>
          <col>Alpha value</col>
        </row>
        <row>
          <literal_col>1</literal_col>
          <col>Red value</col>
        </row>
        <row>
          <literal_col>2</literal_col>
          <col>Green value</col>
        </row>
        <row>
          <literal_col>3</literal_col>
          <col>Blue value</col>
        </row>
      </table>

    </desc>
    <remark>This function does not ensure maximum or minimum limits of color values.</remark>
    <examples>
      <example>
        <code><funclink>GetCursor</funclink>()-&gt;SetColor(DoRGBaValue(<funclink>GetCursor</funclink>()-&gt;<funclink>GetColor</funclink>(),-20,1));</code>
        <text>Reduces the red part of the currently selected clonk by 20.</text>
      </example>
    </examples>
    <related>
      <funclink>GetRGBaValue</funclink>
      <funclink>SetRGBaValue</funclink>
    </related>
  </func>
  <author>Tyron</author><date>2004-08</date>
</funcs>