rom/intuition/freescreenbuffer.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5 */
   6
   7 #include <graphics/rastport.h>
   8 #include <proto/graphics.h>
   9 #include "intuition_intern.h"
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14 #include <intuition/screens.h>
  15 #include <proto/intuition.h>
  16
  17     AROS_LH2(void, FreeScreenBuffer,
  18
  19 /*  SYNOPSIS */
  20          AROS_LHA(struct Screen *      , screen, A0),
  21          AROS_LHA(struct ScreenBuffer *, screenbuffer, A1),
  22
  23 /*  LOCATION */
  24          struct IntuitionBase *, IntuitionBase, 129, Intuition)
  25
  26 /*  FUNCTION
  27     Frees a ScreenBuffer allocated by AllocScreenBuffer() and releases
  28     associated resources. You have to call this before closing your
  29     screen.
  30
  31     INPUTS
  32     screen - The screen this screenbuffer belongs to
  33     screenbuffer - The screenbuffer obtained by AllocScreenBuffer()
  34         It is safe to pass NULL.
  35
  36     RESULT
  37     None.
  38
  39     NOTES
  40     When used SB_SCREEN_BITMAP on allocating the ScreenBuffer
  41     (ie. the ScreenBuffer only refers to the screen's BitMap) you must
  42     FreeScreenBuffer() the ScreenBuffer before closing the screen.
  43     Intuition will recognize when FreeScreenBuffer() is called for the
  44     currently installed ScreenBuffer that it must not free the BitMap.
  45     This is left to the CloseScreen() function.
  46
  47     EXAMPLE
  48
  49     BUGS
  50
  51     SEE ALSO
  52     AllocScreenBuffer(), ChangeScreenBuffer()
  53
  54     INTERNALS
  55
  56     HISTORY
  57
  58 *****************************************************************************/
  59 {
  60     AROS_LIBFUNC_INIT
  61
  62     DEBUG_FREESCREENBUFFER(dprintf("FreeScreenBuffer: Screen 0x%lx ScreenBuffer 0x%lx\n",
  63                                    screen, screenbuffer));
  64
  65     screen = screen;       /* shut up the compiler */
  66
  67     if (screenbuffer)
  68     {
  69         FreeDBufInfo(screenbuffer->sb_DBufInfo);
  70
  71         if (((struct IntScreenBuffer *)screenbuffer)->free_bitmap)
  72             FreeBitMap(screenbuffer->sb_BitMap);
  73
  74         FreeMem(screenbuffer, sizeof(struct IntScreenBuffer));
  75     }
  76
  77     AROS_LIBFUNC_EXIT
  78 } /* FreeScreenBuffer */