<doc>
  <legacy_id>1589</legacy_id>
  <name>subPin</name>
  <type>keyword</type>
  <syntax>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Appearance &amp; Positioning</category>
  </classification>
  <references>
    <keyword tag="notSrcCopy">notSrcCopy Keyword</keyword>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Specifies one of the <glossary tag="transfer mode">transfer modes</glossary> that can be used with the <property tag="ink">ink</property> <glossary tag="property">property</glossary>.</summary>
  <examples>
    <example>set the ink of field 3 to subPin</example>
  </examples>
  <description>
    <p>Use the <b>subPin</b> <glossary tag="keyword">keyword</glossary> to combine an object's color with the colors underneath it.</p><p/><p><b>Comments:</b></p><p>The <b>ink</b> <glossary tag="property">property</glossary> determines how an <glossary tag="object">object's</glossary> colors combine with the colors of the <property tag="pixels">pixels</property> underneath the <glossary tag="object">object</glossary> to determine how the <glossary tag="object">object's</glossary> color is displayed. When the <b>subPin</b> mode is used, each component of the <glossary tag="object">object</glossary> color--red, green, and blue--is subtracted from the corresponding component of the color underneath. If the resulting number is less than 127 (the minimum), 127 is used for that component.</p><p/><p>For example, suppose an object's color is<code> 240,0,100</code>, and the color of the pixels under the object is<code> 60,40,</code>20. If the <b>subPin</b> mode is used, the <glossary tag="object">object's</glossary> displayed color is<code> 180,127,</code>127.</p><p/><p>The <b>subPin</b> mode can be used only on <glossary tag="Mac OS">Mac OS systems</glossary>.  On <glossary tag="Unix">Unix</glossary> and <glossary tag="Windows">Windows systems</glossary>, <glossary tag="object">objects</glossary> whose <property tag="ink">ink</property> <glossary tag="property">property</glossary> is set to this mode appears as though their <property tag="ink">ink</property> were set to <keyword tag="srcCopy">srcCopy</keyword>.</p>
  </description>
</doc>