Points, Rectangles and Regions
<!-- ##### SECTION Short_Description ##### -->
-simple graphical data types.
+Simple graphical data types
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT GdkPoint ##### -->
<para>
-
+Defines the x and y coordinates of a point.
</para>
-@x:
-@y:
+@x: the x coordinate of the point.
+@y: the y coordinate of the point.
<!-- ##### STRUCT GdkRectangle ##### -->
<para>
-
+Defines the position and size of a rectangle.
</para>
-@x:
-@y:
-@width:
-@height:
+@x: the x coordinate of the left edge of the rectangle.
+@y: the y coordinate of the top of the rectangle.
+@width: the width of the rectangle.
+@height: the height of the rectangle.
<!-- ##### FUNCTION gdk_rectangle_intersect ##### -->
<para>
<!-- ##### STRUCT GdkRegion ##### -->
<para>
A GdkRegion represents a set of pixels on the screen.
-The only user-visible field of the structure is the user_data member, which
-can be used to attach arbitrary data to the #GdkRegion.
</para>
<!-- ##### FUNCTION gdk_region_new ##### -->
<para>
-Creates a new empty #GdkRegion.
+
</para>
-@Returns: a new empty #GdkRegion.
+@Returns:
<!-- ##### FUNCTION gdk_region_polygon ##### -->
<para>
-Creates a new #GdkRegion using the polygon defined by a number of points.
</para>
-@points: an array of #GdkPoint structs.
-@npoints: the number of elements in the @points array.
-@fill_rule: specifies which pixels are included in the region when the polygon
-overlaps itself.
-@Returns: a new #GdkRegion based on the given polygon.
+@points:
+@npoints:
+@fill_rule:
+@Returns:
<!-- ##### ENUM GdkFillRule ##### -->
<!-- ##### FUNCTION gdk_region_destroy ##### -->
<para>
-Destroys a #GdkRegion.
+
</para>
-@region: a #GdkRegion.
+@region:
<!-- ##### FUNCTION gdk_region_get_clipbox ##### -->
<para>
-Returns the smallest rectangle which includes the entire #GdkRegion.
+
</para>
-@region: a #GdkRegion.
-@rectangle: returns the smallest rectangle which includes all of @region.
+@region:
+@rectangle:
+
+
+<!-- ##### FUNCTION gdk_region_get_rectangles ##### -->
+<para>
+
+</para>
+
+@region:
+@rectangles:
+@n_rectangles:
<!-- ##### FUNCTION gdk_region_empty ##### -->
<para>
-Returns TRUE if the #GdkRegion is empty.
+
</para>
-@region: a #GdkRegion.
-@Returns: TRUE if @region is empty.
+@region:
+@Returns:
<!-- ##### FUNCTION gdk_region_equal ##### -->
<para>
-Returns TRUE if the two regions are the same.
+
</para>
-@region1: a #GdkRegion.
-@region2: a #GdkRegion.
-@Returns: TRUE if @region1 and @region2 are equal.
+@region1:
+@region2:
+@Returns:
<!-- ##### FUNCTION gdk_region_point_in ##### -->
<para>
-Returns TRUE if a point is in a region.
+
</para>
-@region: a #GdkRegion.
-@x: the x coordinate of a point.
-@y: the y coordinate of a point.
-@Returns: TRUE if the point is in @region.
+@region:
+@x:
+@y:
+@Returns:
<!-- ##### FUNCTION gdk_region_rect_in ##### -->
<para>
-Tests whether a rectangle is within a region.
+
</para>
-@region: a #GdkRegion.
-@rect: a #GdkRectangle.
-@Returns: GDK_OVERLAP_RECTANGLE_IN, GDK_OVERLAP_RECTANGLE_OUT, or
-GDK_OVERLAP_RECTANGLE_PART, depending on whether the rectangle is inside,
-outside, or partly inside the #GdkRegion, respectively.
+@region:
+@rectangle:
+@Returns:
<!-- ##### ENUM GdkOverlapType ##### -->
<!-- ##### FUNCTION gdk_region_offset ##### -->
<para>
-Moves a region the specified distance.
+
</para>
-@region: a #GdkRegion.
-@dx: the distance to move the region horizontally.
-@dy: the distance to move the region vertically.
+@region:
+@dx:
+@dy:
<!-- ##### FUNCTION gdk_region_shrink ##### -->
<para>
-Resizes a region by the specified amount.
-Positive values shrink the region. Negative values expand it.
+
</para>
-@region: a #GdkRegion.
-@dx: the number of pixels to shrink the region horizontally.
-@dy: the number of pixels to shrink the region vertically.
+@region:
+@dx:
+@dy:
<!-- ##### FUNCTION gdk_region_union_with_rect ##### -->
<para>
-Returns the union of a region and a rectangle.
+
</para>
-@region: a #GdkRegion.
-@rect: a #GdkRectangle.
-<!-- # Unused Parameters # -->
-@Returns: the union of @region and @rect.
+@region:
+@rect:
<!-- ##### FUNCTION gdk_region_intersect ##### -->
<para>
-
</para>
@source1:
<!-- ##### FUNCTION gdk_region_subtract ##### -->
<para>
-
</para>
@source1:
<!-- ##### FUNCTION gdk_region_xor ##### -->
<para>
-
</para>
@source1:
<!-- ##### STRUCT GdkSpan ##### -->
<para>
-
+A GdkSpan represents a horizontal line of pixels starting
+at the pixel with coordinates @x, @y and ending before @x + @width, @y.
</para>
-@x:
-@y:
-@width:
+@x: x coordinate of the first pixel.
+@y: y coordinate of the first pixel.
+@width: number of pixels in the span.
<!-- ##### USER_FUNCTION GdkSpanFunc ##### -->
<para>
-
+This defines the type of the function passed to
+gdk_region_spans_intersect_foreach().
</para>
-@span: The intersected part of the span.
-@data: Opaque data passed by user.
+@span: a #GdkSpan.
+@data: the user data passed to gdk_region_spans_intersect_foreach().
<!-- ##### FUNCTION gdk_region_spans_intersect_foreach ##### -->
<para>
-Intersects a set of spans with a region and call a user specified
-function for each resulting spanline. This function is a lot more effective
-if the spans are sorted.
+
</para>
-@region: The region to intersect against.
-@spans: Array of spans to intersect.
-@n_spans: Number of spans.
-@sorted: True if the spans are sorted in increasing y order.
-@function: The function to call for each intersected spanline.
-@data: Opaque user data passed to function.
+@region:
+@spans:
+@n_spans:
+@sorted:
+@function:
+@data:
projects / ~andy / gtk / blobdiff