SHIP:Property:image:preloadpolicy

From Serious Documentation
Jump to: navigation, search

Node: image

Property Data Type Description
preloadpolicy** preloadpolicy Directs if/when an image is staged into RAM at runtime.

**The preloadpolicy property cannot be referenced in scripts.

Images are stored in the cargo file and loaded at runtime by SHIPEngine. The preloadpolicy setting controls if and when this image is preloaded (i.e. staged) into system from the cargo file in the flash file system. There are three options:

  1. PRELOAD_NEVER - never stage this image into RAM and on every render pull the required data from the file on the fly. This setting saves system RAM at the expense of render times. Use this setting for infrequently used images or images in areas of the screen that are unchanging most of the time.
  2. PRELOAD_ONBOOT - preload the image into RAM when the GUI is loaded at boot time. This setting may create a noticeable pause when the system boots as images are loaded into RAM, however when they are needed the images are immediately ready for use.
  3. PRELOAD_LAZY - preload the image into RAM when the GUI first references the image.

The default, if not set, is PRELOAD_LAZY.