Minor fixes to comments.
[AROS.git] / rom / graphics / freeraster.c
blobb9b4f447e634ace64ed8cd435a3557341bda9f7b
1 /*
2 Copyright © 1995-2007, The AROS Development Team. All rights reserved.
3 $Id$
5 Desc: Return the memory occupied by a single bitplane to the system.
6 Lang: english
7 */
8 #include <exec/memory.h>
9 #include <proto/exec.h>
10 #include "graphics_intern.h"
12 /*****************************************************************************
14 NAME */
15 #include <graphics/gfx.h>
16 #include <proto/graphics.h>
18 AROS_LH3(void, FreeRaster,
20 /* SYNOPSIS */
21 AROS_LHA(PLANEPTR, p, A0),
22 AROS_LHA(UWORD, width, D0),
23 AROS_LHA(UWORD, height, D1),
25 /* LOCATION */
26 struct GfxBase *, GfxBase, 83, Graphics)
28 /* FUNCTION
29 Free the single bitplane allocated by AllocRaster().
31 INPUTS
32 p - The result of AllocRaster(). Must be non-NULL.
33 width, height - The size of the bitplane as passed to AllocRaster().
35 RESULT
36 The memory occupied by the bitplane will be returned to the system.
38 NOTES
40 EXAMPLE
42 BUGS
44 SEE ALSO
45 AllocRaster(), AllocBitMap(), FreeBitMap()
47 INTERNALS
49 HISTORY
51 *****************************************************************************/
53 AROS_LIBFUNC_INIT
55 FreeMem (p, RASSIZE(width, height));
57 AROS_LIBFUNC_EXIT
58 } /* FreeRaster */