rom/hyperlayers/installclipregion.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: english
   7 */
   8 #include <aros/libcall.h>
   9 #include <graphics/clip.h>
  10 #include <exec/types.h>
  11 #include <proto/exec.h>
  12 #include <graphics/layers.h>
  13 #include <proto/layers.h>
  14 #include "layers_intern.h"
  15 #include "basicfuncs.h"
  16
  17 /*****************************************************************************
  18
  19     NAME */
  20
  21         AROS_LH2(struct Region *, InstallClipRegion,
  22
  23 /*  SYNOPSIS */
  24         AROS_LHA(struct Layer  *, l     , A0),
  25         AROS_LHA(struct Region *, region, A1),
  26
  27 /*  LOCATION */
  28         struct LayersBase *, LayersBase, 29, Layers)
  29
  30 /*  FUNCTION
  31        Install a transparent Clip region in the layer. All subsequent
  32        graphics call to the rastport of the layer will be clipped to
  33        that region.
  34        None of the system functions will free the ClipRegion for you,
  35        so you will have to call InstallClipRegion(l, NULL) before
  36        closing a window or deleting a layer.
  37
  38     INPUTS
  39        l      - pointer to layer
  40        region - pointer to region to be clipped against.
  41
  42     RESULT
  43
  44     NOTES
  45
  46     EXAMPLE
  47
  48     BUGS
  49
  50     SEE ALSO
  51
  52     INTERNALS
  53
  54     HISTORY
  55         27-11-96    digulla automatically created from
  56                             layers_lib.fd and clib/layers_protos.h
  57
  58 *****************************************************************************/
  59 {
  60   AROS_LIBFUNC_INIT
  61   AROS_LIBBASE_EXT_DECL(struct LayersBase *,LayersBase)
  62
  63   struct Region * OldRegion;
  64
  65   LockLayer(0, l);
  66
  67   OldRegion = _InternalInstallClipRegion(l, region, 0, 0, LayersBase);
  68
  69   UnlockLayer(l);
  70
  71   return OldRegion;
  72
  73   AROS_LIBFUNC_EXIT
  74 } /* InstallClipRegion */