Minor fixes to comments.
[AROS.git] / rom / graphics / freesprite.c
blob6d485dcd0fd6cb431b05135311f6761f401c8e8e
1 /*
2 Copyright © 1995-2007, The AROS Development Team. All rights reserved.
3 $Id$
5 Desc: Graphics function FreeSprite()
6 Lang: english
7 */
8 #include <graphics/gfxbase.h>
9 #include <proto/exec.h>
10 #include "graphics_intern.h"
12 /*****************************************************************************
14 NAME */
15 #include <proto/graphics.h>
17 AROS_LH1(void, FreeSprite,
19 /* SYNOPSIS */
20 AROS_LHA(WORD, pick, D0),
22 /* LOCATION */
23 struct GfxBase *, GfxBase, 69, Graphics)
25 /* FUNCTION
26 Free a via GetSprite previously allocated sprite.
27 Don't even dare to free a sprite you didn't allocate.
29 INPUTS
30 pick - number of sprite in range 0-7
32 RESULT
33 Sprite is made available for other tasks and the Virtual Sprite
34 Machine.
36 NOTES
38 EXAMPLE
40 BUGS
42 SEE ALSO
43 GetSprite(), ChangeSprite(), MoveSprite(), graphics/sprite.h
45 INTERNALS
47 HISTORY
49 *****************************************************************************/
51 AROS_LIBFUNC_INIT
53 if (pick < 8) {
54 UBYTE Mask = (0x01 << pick) ^ 0xff;
55 Disable();
56 GfxBase->SpriteReserved &= Mask;
57 Enable();
59 AROS_LIBFUNC_EXIT
60 } /* FreeSprite */