xclipbox(3) [x11r4 man page]

XPolygonRegion(3)						  XLIB FUNCTIONS						 XPolygonRegion(3)

NAME

       XPolygonRegion, XClipBox - generate regions

SYNTAX

       Region XPolygonRegion(XPoint points[], int n, int fill_rule);

       int XClipBox(Region r, XRectangle *rect_return);

ARGUMENTS

       fill_rule Specifies the fill-rule you want to set for the specified GC.	You can pass EvenOddRule or WindingRule.

       n	 Specifies the number of points in the polygon.

       points	 Specifies an array of points.

       r	 Specifies the region.

       rect_return
		 Returns the smallest enclosing rectangle.

DESCRIPTION

       The XPolygonRegion function returns a region for the polygon defined by the points array.  For an explanation of fill_rule, see XCreateGC.

       The XClipBox function returns the smallest rectangle enclosing the specified region.

SEE ALSO

       XCreateGC(3X11), XDrawPoint(3X11), XDrawRectangle(3X11)
       Xlib - C Language X Interface

X Version 11							   libX11 1.2.1 						 XPolygonRegion(3)

XPolygonRegion()														  XPolygonRegion()

Name
  XPolygonRegion - generate a region from points in a polygon.

Synopsis
  Region XPolygonRegion(points, n, fill_rule)
	XPoint points[];
	int n;
	int fill_rule;

Arguments
  points    Specifies a pointer to an array of points.

  n	    Specifies the number of points in the polygon.

  fill_rule Specifies  whether	areas overlapping an odd number of times should be part of the region (WindingRule) or not part of the region
	    (EvenOddRule).  See Volume One, Chapter 5, The Graphics Context, for a description of the fill rule.

Returns
  The created region.

Description
  XPolygonRegion() creates a region defined by connecting the specified points, and returns a pointer to be used to refer to the region.

  Regions are located relative to a point (the region origin) which is common to all regions.  In XPolygonRegion(), the coordinates specified
  in points are relative to the region origin.	By specifying all points relative to the drawable in which they will be used, the region ori-
  gin can be coincident with the drawable origin.  It is up to the application whether to interpret the location of the region relative to  a
  drawable or not.

  If  the  region  is to be used as a clip_mask by calling XSetRegion(), the upper-left corner of the region relative to the drawable used in
  the graphics request will be at (xoffset + clip_x_origin, yoffset + clip_y_origin), where xoffset and yoffset are the offset of the  region
  (if  any)  and  clip_x_origin  and clip_y_origin are elements of the GC used in the graphics request.  The fill_rule can be either of these
  values:

  EvenOddRule	 Areas overlapping an odd number of times are not part of the region.

  WindingRule	 Overlapping areas are always filled.

  For more information on structures, see Volume One, Chapter 6, Drawing Graphics and Text.

Structures
  Region is a pointer to an opaque structure type.

See Also
  XClipBox(), XCreateRegion(),	XDestroyRegion(),  XEmptyRegion(),  XEqualRegion(),  XIntersectRegion(),  XOffsetRegion(),  XPointInRegion(),
  XRectInRegion(), XSetRegion(), XShrinkRegion(), XSubtractRegion(), XUnionRectWithRegion(), XUnionRegion(), XXorRegion().

Xlib - Regions															  XPolygonRegion()