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

   1 ;
   2 ; resspr.sh
   3 ;
   4 ; Handling of the application's private sprite area
   5 ;
   6 ; © 1994-1998 Straylight
   7 ;
   8
   9 ;----- Licensing note -------------------------------------------------------
  10 ;
  11 ; This file is part of Straylight's Sapphire library.
  12 ;
  13 ; Sapphire is free software; you can redistribute it and/or modify
  14 ; it under the terms of the GNU General Public License as published by
  15 ; the Free Software Foundation; either version 2, or (at your option)
  16 ; any later version.
  17 ;
  18 ; Sapphire is distributed in the hope that it will be useful,
  19 ; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ; GNU General Public License for more details.
  22 ;
  23 ; You should have received a copy of the GNU General Public License
  24 ; along with Sapphire.  If not, write to the Free Software Foundation,
  25 ; 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  26
  27 ;----- Overview -------------------------------------------------------------
  28 ;
  29 ; Functions provided:
  30 ;
  31 ;  resspr_load
  32 ;  resspr_area
  33 ;  resspr_init
  34
  35                 [       :LNOT::DEF:resspr__dfn
  36                 GBLL    resspr__dfn
  37
  38 ; --- resspr_load ---
  39 ;
  40 ; On entry:     R0 == pointer to filename
  41 ;
  42 ; On exit:      May return an error
  43 ;
  44 ; Use:          Loads a sprite file into memory and allows it to be
  45 ;               referenced through resspr_area.  Note that Straylight's
  46 ;               Sprinkle module must be loaded if more than one sprite file
  47 ;               is to be used for resources.
  48
  49                 IMPORT  resspr_load
  50
  51 ; --- resspr_area ---
  52 ;
  53 ; On entry:     --
  54 ;
  55 ; On exit:      R0 == pointer to application's sprite area
  56 ;
  57 ; Use:          Locates the application's `Sprites' resource in memory and
  58 ;               returns a pointer to it.  If the resource has not been
  59 ;               loaded, 1 is returned, to indicate to use the WIMP area.
  60 ;               If multiple sprite files have been loaded, this call returns
  61 ;               the address of the first: they will have been linked together
  62 ;               so that Sprinkle will treat them as one big area.
  63
  64                 IMPORT  resspr_area
  65
  66 ; --- resspr_init ---
  67 ;
  68 ; On entry:     R0 == pointer to application name
  69 ;
  70 ; On exit:      --
  71 ;
  72 ; Use:          Initalises resspr, loading the Sprites resource.
  73
  74                 IMPORT  resspr_init
  75
  76                 ]
  77
  78 ;----- That's all, folks ----------------------------------------------------
  79
  80                 END