<?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>SetClrModulation</title>
    <category>Objects</category>
    <subcat>Display</subcat>
    <version>1.0 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>int</type>
          <name>color</name>
          <desc>Color value to be modulated with.</desc>
        </param>
        <param>
          <type>int</type>
          <name>overlay_id</name>
          <desc>If specified, sets the color modulation of the graphics overlay instead. The overlay must have been created using <funclink>SetGraphics</funclink> first.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Changes the color modulation of an object. This is a color value which is multiplied with the object color. <funclink>RGB</funclink>(255,0,0) will only let the red part of the color show. <funclink>RGBa</funclink>(255,255,255,128) will make all color half transparent.</desc>
    <examples>
      <example>
        <code><funclink>GetCursor</funclink>()-&gt;SetClrModulation(<funclink>RGBa</funclink>(128,128,255,128));</code>
        <text>Colors the selected clonk of the first player slightly blue and makes him half transparent.</text>
      </example>
    </examples>
    <related>
      <funclink>RGB</funclink>
      <funclink>RGBa</funclink>
      <funclink>SetGamma</funclink>
      <funclink>GetClrModulation</funclink>
      <funclink>SetObjectBlitMode</funclink>
      <funclink>SetColor</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2002-04</date>
</funcs>
