<?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>GetClrModulation</title>
    <category>Objects</category>
    <subcat>Display</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>int</type>
          <name>overlay_id</name>
          <desc>If specified, the color modulation of the overlay is returned instead. The overlay must be set using <funclink>SetGraphics</funclink> first.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Determines the color modulation of an object. This is a color value which is multiplied (or added, according to BlitMode) with the object graphics. For more information see <funclink>SetClrModulation</funclink>().</desc>
    <remark>A return value of -1 means that no color modulation is done. This corresponds to <funclink>RGBa</funclink>(255,255,255,255).</remark>
    <examples>
      <example>
        <code>global func SetObjAlpha(byAlpha, obj)
  {
  var dwClrMod = obj-&gt;GetClrModulation();
  <funclink>if</funclink> (!dwClrMod)
		dwClrMod = byAlpha &lt;&lt; 24;
	else
		dwClrMod = dwClrMod &amp; <funclink>RGB(255,255,255)</funclink> | byAlpha &lt;&lt; 24;
  <funclink>return</funclink>(obj-&gt;<funclink>SetClrModulation</funclink>(dwClrMod));
  }</code>
        <text>Global function: only sets the alpha value of the color modulation of an object.</text>
      </example>
    </examples>
    <related>
      <funclink>RGB</funclink>
      <funclink>RGBa</funclink>
      <funclink>SetGamma</funclink>
      <funclink>SetClrModulation</funclink>
      <funclink>GetColor</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2004-02</date>
</funcs>
