rom/graphics/getextspritea.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Graphics function GetExtSpriteA()
   6     Lang: english
   7 */
   8 #include <aros/debug.h>
   9 #include <graphics/sprite.h>
  10 #include <utility/tagitem.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15 #include <proto/graphics.h>
  16
  17         AROS_LH2(LONG, GetExtSpriteA,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct ExtSprite *, sprite, A2),
  21         AROS_LHA(struct TagItem *, tags, A1),
  22
  23 /*  LOCATION */
  24         struct GfxBase *, GfxBase, 155, Graphics)
  25
  26 /*  FUNCTION
  27
  28     INPUTS
  29         sprite - pointer to programmer's ExtSprite (from AllocSpriteData())
  30         tags   - a standard tag list
  31
  32     RESULT
  33         Sprite_number - a sprite number or -1 for an error
  34
  35     NOTES
  36
  37     EXAMPLE
  38
  39     BUGS
  40
  41     SEE ALSO
  42
  43     INTERNALS
  44         AROS does not have complete sprite system, instead it has a (hacky)
  45         minimal implementation enough to drive mouse pointer as a single
  46         sprite #0. This assumes that this sprite is always allocated by the OS
  47         itself and can't be used by user applications. So we just return error.
  48
  49     HISTORY
  50
  51
  52 ******************************************************************************/
  53 {
  54     AROS_LIBFUNC_INIT
  55
  56     return -1;
  57
  58     AROS_LIBFUNC_EXIT
  59 } /* GetExtSpriteA */