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 #include "graphics_intern.h"
  13
  14 /*****************************************************************************
  15
  16     NAME */
  17 #include <proto/graphics.h>
  18
  19         AROS_LH2(LONG, GetExtSpriteA,
  20
  21 /*  SYNOPSIS */
  22         AROS_LHA(struct ExtSprite *, sprite, A2),
  23         AROS_LHA(struct TagItem *, tags, A1),
  24
  25 /*  LOCATION */
  26         struct GfxBase *, GfxBase, 155, Graphics)
  27
  28 /*  FUNCTION
  29
  30     INPUTS
  31         sprite - pointer to programmer's ExtSprite (from AllocSpriteData())
  32         tags   - a standard tag list
  33
  34     RESULT
  35         Sprite_number - a sprite number or -1 for an error
  36
  37     NOTES
  38
  39     EXAMPLE
  40
  41     BUGS
  42
  43     SEE ALSO
  44
  45     INTERNALS
  46         AROS does not have complete sprite system, instead it has a (hacky)
  47         minimal implementation enough to drive mouse pointer as a single
  48         sprite #0. This assumes that this sprite is always allocated by the OS
  49         itself and can't be used by user applications. So we just return error.
  50
  51     HISTORY
  52
  53
  54 ******************************************************************************/
  55 {
  56     AROS_LIBFUNC_INIT
  57
  58     return -1;
  59
  60     AROS_LIBFUNC_EXIT
  61 } /* GetExtSpriteA */