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

31 lines
1.1 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>ResetGamma</title>
<category>Global</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>ramp_index</name>
<desc>0-7: index of the gamma ramp to reset.</desc>
</param>
</params>
</syntax>
<desc>Resets a gamma ramp to default value. This corresponds to <funclink>SetGamma</funclink>(<funclink>RGB</funclink>(0,0,0), <funclink>RGB</funclink>(128,128,128), <funclink>RGB</funclink>(255,255,255), ramp_index);. For more information see <funclink>SetGamma</funclink>.</desc>
<examples>
<example>
<code><funclink>for</funclink> (var i=0; i&lt;8; i++) ResetGamma(i);</code>
<text>Deactivates all gamma ramps.</text>
</example>
</examples>
<related><funclink>SetGamma</funclink></related>
</func>
<author>Sven2</author><date>2002-04</date>
</funcs>