openclonk/docs/sdk/script/fn/SplitRGBaValue.xml

36 lines
1.3 KiB
XML

<?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>SplitRGBaValue</title>
<category>Arithmetics</category>
<version>5.1 OC (returns proplist since 8.0 OC)</version>
<syntax>
<rtype>proplist</rtype>
<params>
<param>
<type>int</type>
<name>rgba</name>
<desc>32 bit color value</desc>
</param>
</params>
</syntax>
<desc>Returns a proplist with the red, green, blue, and alpha values of the specified 32 bit color value: <code>{R = red, G = green, B = blue, Alpha = alpha}</code></desc>
<examples>
<example>
<code>var rgba = SplitRGBaValue(<funclink>GetCursor</funclink>()-&gt;<funclink>GetColor</funclink>());
<funclink>GetCursor</funclink>()-&gt;<funclink>Message</funclink>(&quot;R: %d|G: %d|B: %d|A: %d&quot;, rgba.R, rgba.G, rgba.B, rgba.Alpha);
</code>
<text>Displays the four color values of the currently selected clonk above the clonk's head.</text>
</example>
</examples>
<related>
<funclink>GetRGBaValue</funclink>
<funclink>SetRGBaValue</funclink>
</related>
</func>
<author>Tyron</author><date>2004-09</date>
</funcs>