mdw@git.distorted.org.uk Git - ssr/blob - StraySrc/Libraries/Sapphire/csapph/h/resspr

   1 /*
   2  * resspr.h
   3  *
   4  * [Generated from resspr, 25 September 1996]
   5  */
   6
   7 #if !defined(__CC_NORCROFT) || !defined(__arm)
   8   #error You must use the Norcroft ARM Compiler for Sapphire programs
   9 #endif
  10
  11 #pragma include_only_once
  12 #pragma force_top_level
  13
  14 #ifndef __resspr_h
  15 #define __resspr_h
  16
  17 #ifndef __sapphire_h
  18   #include "sapphire.h"
  19 #endif
  20
  21 /*----- Overview ----------------------------------------------------------*
  22  *
  23  * Functions provided:
  24  *
  25  *  resspr_load
  26  *  resspr_area
  27  *  resspr_init
  28  */
  29
  30 /* --- resspr_load --- *
  31  *
  32  * On entry:    R0 == pointer to filename
  33  *
  34  * On exit:     May return an error
  35  *
  36  * Use:         Loads a sprite file into memory and allows it to be
  37  *              referenced through resspr_area.  Note that Straylight's
  38  *              Sprinkle module must be loaded if more than one sprite file
  39  *              is to be used for resources.
  40  */
  41
  42 extern routine resspr_load;
  43
  44 /* --- resspr_area --- *
  45  *
  46  * On entry:    --
  47  *
  48  * On exit:     R0 == pointer to application's sprite area
  49  *
  50  * Use:         Locates the application's `Sprites' resource in memory and
  51  *              returns a pointer to it.  If the resource has not been
  52  *              loaded, 1 is returned, to indicate to use the WIMP area.
  53  *              If multiple sprite files have been loaded, this call returns
  54  *              the address of the first: they will have been linked together
  55  *              so that Sprinkle will treat them as one big area.
  56  */
  57
  58 extern routine resspr_area;
  59
  60 /* --- resspr_init --- *
  61  *
  62  * On entry:    R0 == pointer to application name
  63  *
  64  * On exit:     --
  65  *
  66  * Use:         Initalises resspr, loading the Sprites resource.
  67  */
  68
  69 extern routine resspr_init;
  70
  71 /*----- That's all, folks -------------------------------------------------*/
  72
  73 #endif