compiler/alib/newrectregion.c

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Graphics function NewRectRegion()
   6     Lang: english
   7 */
   8
   9 #include <graphics/regions.h>
  10 #include <proto/graphics.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15 #include <proto/alib.h>
  16
  17         struct Region *NewRectRegion(
  18
  19 /*  SYNOPSIS */
  20         WORD MinX,
  21         WORD MinY,
  22         WORD MaxX,
  23         WORD MaxY)
  24
  25 /*  FUNCTION
  26         Creates a new rectangular Region
  27
  28     INPUTS
  29         MinX, MinY, MaxX, MaxY - The extent of the Rect
  30
  31     RESULT
  32         Pointer to the newly created Region. NULL on failure.
  33
  34     NOTES
  35         This function is a shorthand for:
  36
  37             struct Rectangle rect;
  38             struct Region *region;
  39
  40             rect.MinX = MinX;
  41             rect.MinY = MinY;
  42             rect.MaxX = MaxX;
  43             rect.MaxY = MaxY;
  44
  45             region = NewRegion();
  46             OrRectRegion(region, &rect);
  47
  48     EXAMPLE
  49
  50     BUGS
  51
  52     SEE ALSO
  53
  54     INTERNALS
  55
  56     HISTORY
  57         15-12-2000  stegerg implemented
  58
  59 *****************************************************************************/
  60 {
  61     struct Region *region = NewRegion();
  62
  63     if (region)
  64     {
  65         struct Rectangle rect = {MinX, MinY, MaxX, MaxY};
  66         BOOL res = OrRectRegion(region, &rect);
  67
  68         if (res)
  69             return region;
  70
  71         DisposeRegion(region);
  72     }
  73
  74     return NULL;
  75
  76 } /* NewRectRegion */