home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / program / basic / eventshell / Docs / Sprites < prev    next >
Encoding:
Text File  |  1995-11-25  |  3.8 KB  |  155 lines
  1.  
  2. FNshell_SpriteAreaLoad()
  3. =>    str    file name of sprite file
  4.  
  5. <=    int    address of sprite area containing
  6.          loaded file
  7.  
  8. Creates a new sprite area and loads an existing
  9. file into it, returning a pointer to the area.
  10.  
  11. --------------------------------------------------------
  12.  
  13. PROCshell_SpriteAreaSave()
  14. =>    int    address of spritearea (as returned
  15.          by FNshell_SpriteAreaLoad>
  16.     str    file name
  17.  
  18. --------------------------------------------------------
  19.  
  20. FNshell_UserSpritesBase
  21. =>    None
  22.  
  23. <=    int    address that user sprite file has
  24.          been loaded at
  25.              
  26. --------------------------------------------------------
  27.  
  28. FNshell_SpriteGetPtr()
  29. =>    int    address of spritearea (as returned
  30.          by FNshell_SpriteAreaLoad>
  31.     str    name of sprite
  32.  
  33. <=int    pointer to sprite
  34.  
  35. This call is used to get a pointer to a sprite
  36. that can be passed to other routines. 
  37.  
  38. --------------------------------------------------------
  39.  
  40. PROCshell_SpriteRename()
  41. =>    int    address of spritearea (as returned
  42.          by FNshell_SpriteAreaLoad
  43.     str    old name of sprite
  44.     str    new name of sprite
  45.  
  46. --------------------------------------------------------
  47.  
  48. FNshell_SpriteExists()
  49. =>    int    address of spritearea (1 for wimp
  50.          pool, FNshell_UserSpritesBase for
  51.          user area)
  52.     str    sprite name
  53.  
  54. <=    bool    TRUE or FALSE
  55.  
  56. It is probably better to use the two associated
  57. calls FNshell_SpriteExistsInWimpPool and
  58. FNshell_SpriteExistsInUserArea as it makes it
  59. more obvious what the call is doing.
  60.  
  61. --------------------------------------------------------
  62.  
  63. FNshell_SpriteExistsInWimpPool(()
  64. =>    str    sprite name
  65.  
  66. <=    bool    TRUE or FALSE
  67.  
  68. Effectively checks whether the sprite has been
  69. defined in the !Sprites/!Sprites22 file.
  70.  
  71. --------------------------------------------------------
  72.  
  73. FNshell_SpriteExistsInUserArea()
  74. =>    str    sprite name
  75.  
  76. <=    bool    TRUE or FALSE
  77.  
  78. Effectively checks whether the sprite has been
  79. defined in the Sprites/Sprites22 file.
  80.  
  81. --------------------------------------------------------
  82.  
  83. PROCshell_SpriteAreaInit()
  84. =>    int    address of sprite area
  85.     int    size of area
  86.  
  87. Prepares a block of memory for use as a sprite area.
  88.  
  89. --------------------------------------------------------
  90.  
  91. PROCshell_SpriteLoad()
  92. =>    int    address of sprite area
  93.     str    full file name of a sprite file
  94.  
  95. Loads a sprite file into an area of memory previously
  96. prepared by PROCshell_SpriteAreaInit.
  97.  
  98. --------------------------------------------------------
  99.  
  100. PROCshell_SpriteRemoveLeftWastage()
  101. =>    int    address of sprite area
  102.     str    sprite name
  103.     int    pointer to sprite
  104.  
  105. Makes sure that the sprite is aligned on a word
  106. boundary. If a sprite pointer is given it will be used,
  107. if not the sprite name will be used to access the
  108. sprite. (Pointers are faster).
  109.  
  110. --------------------------------------------------------
  111.  
  112. PROCshell_SpriteGetSize()
  113. =>    int    address of sprite area
  114.     str    sprite name
  115.     int    pointer to sprite
  116.     int    width    (updated on return)
  117.     int    height    (updated on return)
  118.  
  119. If a sprite pointer is given it will be used,
  120. if not the sprite name will be used to access the
  121. sprite. (Pointers are faster).
  122.  
  123. --------------------------------------------------------
  124.  
  125. PROCshell_SpriteGetMode()
  126. =>    int    address of sprite area
  127.     str    sprite name
  128.     int    pointer to sprite
  129.     int    mode (updated on return)
  130.  
  131. If a sprite pointer is given it will be used,
  132. if not the sprite name will be used to access the
  133. sprite. (Pointers are faster).
  134.  
  135. --------------------------------------------------------
  136.  
  137. PROCshell_SpriteLoadAsDraw
  138. =>    str    file name of sprite file
  139.     int    file size
  140.     int    x offset    (OS units)
  141.     int    y offset    (OS units)
  142.     int    address of drawfile buffer    (updated on return)
  143.     int    sprite area handle        (updated on return)
  144.  
  145. Creates a DrawFile buffer containing the specified
  146. sprite file.
  147.  
  148. --------------------------------------------------------
  149.  
  150. FNshell_SpritesGetHeaderSize
  151. =>    None
  152.  
  153. =    int    size of sprite file header
  154.  
  155. --------------------------------------------------------