File: GetRGBaValue.xml

package info (click to toggle)
openclonk 8.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 169,656 kB
  • sloc: cpp: 180,484; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 148; sh: 101; javascript: 34
file content (63 lines) | stat: -rw-r--r-- 1,619 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
<?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>GetRGBaValue</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>select</name>
          <desc>0-3: desired value to be returned</desc>
        </param>
      </params>
    </syntax>
    <desc>
      Returns one of the three color fractions of the specified 32 bit color value: 
      <table>
        <rowh>
          <col>select</col>
          <col>Return value</col>
        </rowh>
        <row>
          <col>0</col>
          <col>Alpha value</col>
        </row>
        <row>
          <col>1</col>
          <col>Red value</col>
        </row>
        <row>
          <col>2</col>
          <col>Green value</col>
        </row>
        <row>
          <col>3</col>
          <col>Blue value</col>
        </row>
      </table>

    </desc>
    <examples>
      <example>
        <code>GetRGBaValue(<funclink>GetColor</funclink>(<funclink>GetCursor</funclink>()),2);</code>
        <text>Returns the green fraction of the currently selected clonk.</text>
      </example>
    </examples>
    <related>
      <funclink>RGBa</funclink>
      <funclink>SetRGBaValue</funclink>
    </related>
  </func>
  <author>Tyron</author><date>2004-08</date>
</funcs>