<doc>
  <legacy_id>2224</legacy_id>
  <name>eraser</name>
  <type>property</type>
  <syntax>
    <example>set the eraser to {<i>brushID</i> |<i> imageID</i>}</example>
  </syntax>
  <library></library>
  <objects>
    <global/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Developing with LiveCode</category>
  </classification>
  <references>
    <command tag="choose">choose Command</command>
    <property tag="spray">spray Property</property>
    <property tag="brush">brush Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Specifies the shape used for the Eraser <glossary tag="paint tool">paint tool</glossary>.</summary>
  <examples>
    <example>set the eraser to 12</example>
  </examples>
  <description>
    <p>Use the <b>eraser</b> <glossary tag="property">property</glossary> to specify which shape is painted by the Eraser <function tag="tool">tool</function>.</p><p/><p><b>Value:</b></p><p>The <b>eraser</b> is a brush specifier.</p><p/><p>A <i>brushID</i> is a built-in brush number between 1 and 35. (These brushes correspond to LiveCode's built-in patterns 101 to 135.)</p><p/><p>An <i>imageID</i> is the ID of an <keyword tag="image">image</keyword> to use for erasing. LiveCode looks for the specified <keyword tag="image">image</keyword> first in the <glossary tag="current stack">current stack</glossary>, then in other open <function tag="stacks">stacks</function>.</p><p/><p>By default, the <b>eraser</b> is set to 2 (a square eraser).</p><p/><p><b>Comments:</b></p><p>The entire area of the eraser cursor is used as the eraser shape. The shape erased by the eraser is cleared to transparent, regardless of what colors might be in the image used for the eraser shape.</p><p/><p>When the Eraser tool is in use, the cursor is the same as the eraser shape. You can use any size image as an eraser, but the cursor may appear distorted on some systems if the image is not 16x16 pixels.</p>
  </description>
</doc>