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

70 lines
1.9 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>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>