<doc>
  <legacy_id></legacy_id>
  <name>prepare image</name>
  <type>command</type>
  <syntax>
    <example>prepare image <i>name</i></example>
    <example>prepare image file <i>filename</i></example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Images &amp; Multimedia</category>
  </classification>
  <references>
    <command tag="prepare">prepare Command</command>
  </references>
  <history>
    <introduced version="6.0.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Preloads an image into memory.</summary>
  <examples>
    <example>prepare image "myImage"</example>
    <example>prepare image file "/Disk/Folder/logo.jpg"</example>
  </examples>
  <description>  
    <p>Use the <b>prepare image</b> <glossary tag="command">command</glossary> to speed up <glossary tag="execute">execution</glossary> when showing image data.</p><p/><p><b>Parameters:</b></p><p>The <i>name</i> specifies what image is forced to be decompressed into the image cache.</p><p/><p>The <i>filename</i> is the location and name of the image <keyword tag="file">file</keyword> you want to load and decompress into the image data cache. Since the image data cache is keyed on the absolute filename, any images which reference that file are able to use the data from the cache. This assumes that the cache has not been flushed.</p><p/><p><b>Comments:</b></p><p>Use the <b>prepare image</b> <glossary tag="command">command</glossary> to preload an image at some time before it is needed. Then access the image and display it as needed on your stack. Since the image is already cached into memory, it displays instantly.</p>
  </description>
</doc>