summaryrefslogtreecommitdiff
path: root/docs/reference/gdk/tmpl/regions.sgml
diff options
context:
space:
mode:
authorBenjamin Otte <otte@redhat.com>2010-06-28 16:19:56 +0200
committerBenjamin Otte <otte@redhat.com>2010-06-29 16:06:58 +0200
commit5a02283fbfcda0eac3b96a8a287a45877533efd4 (patch)
tree0a614a08c3925fbba0c96d81fdd72123e91fb5f0 /docs/reference/gdk/tmpl/regions.sgml
parent6c5dffd1a39133753b865880f1674e6b82d480d2 (diff)
downloadgtk+-5a02283fbfcda0eac3b96a8a287a45877533efd4.tar.gz
API: Remove all GdkRegion API
Remove the deprecated region APIs completely from GTK. https://bugzilla.gnome.org/show_bug.cgi?id=613284
Diffstat (limited to 'docs/reference/gdk/tmpl/regions.sgml')
-rw-r--r--docs/reference/gdk/tmpl/regions.sgml251
1 files changed, 5 insertions, 246 deletions
diff --git a/docs/reference/gdk/tmpl/regions.sgml b/docs/reference/gdk/tmpl/regions.sgml
index 4de1b2b798..5236c54230 100644
--- a/docs/reference/gdk/tmpl/regions.sgml
+++ b/docs/reference/gdk/tmpl/regions.sgml
@@ -1,13 +1,14 @@
<!-- ##### SECTION Title ##### -->
-Points, Rectangles and Regions
+Points and Rectangles
<!-- ##### SECTION Short_Description ##### -->
Simple graphical data types
<!-- ##### SECTION Long_Description ##### -->
<para>
-GDK provides the #GdkPoint, #GdkRectangle, #GdkRegion and #GdkSpan data types
-for representing pixels and sets of pixels on the screen.
+GDK provides the #GdkPoint and #GdkRectangle data types for representing pixels
+and sets of pixels on the screen. Together with Cairo's #cairo_region_t data
+type, they make up the central types for representing graphical data.
</para>
<para>
#GdkPoint is a simple structure containing an x and y coordinate of a point.
@@ -19,13 +20,7 @@ gdk_rectangle_intersect(). To find the union of two rectangles use
gdk_rectangle_union().
</para>
<para>
-#GdkRegion is an opaque data type holding a set of arbitrary pixels, and is
-usually used for clipping graphical operations (see gdk_gc_set_clip_region()).
-</para>
-<para>
-#GdkSpan is a structure holding a spanline. A spanline is a horizontal line that
-is one pixel wide. It is mainly used when rasterizing other graphics primitives.
-It can be intersected to regions by using gdk_region_spans_intersect_foreach().
+#cairo_region_t is usually used for managing clipping of graphical operations.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -75,239 +70,3 @@ Defines the position and size of a rectangle. It is identical to
@dest:
-<!-- ##### STRUCT GdkRegion ##### -->
-<para>
-A GdkRegion represents a set of pixels on the screen.
-</para>
-
-
-<!-- ##### FUNCTION gdk_region_new ##### -->
-<para>
-
-</para>
-
-@void:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_region_polygon ##### -->
-<para>
-
-</para>
-
-@points:
-@n_points:
-@fill_rule:
-@Returns:
-
-
-<!-- ##### ENUM GdkFillRule ##### -->
-<para>
-The method for determining which pixels are included in a region, when
-creating a #GdkRegion from a polygon.
-The fill rule is only relevant for polygons which overlap themselves.
-</para>
-
-@GDK_EVEN_ODD_RULE: areas which are overlapped an odd number of times are
-included in the region, while areas overlapped an even number of times are not.
-@GDK_WINDING_RULE: overlapping areas are always included.
-
-<!-- ##### FUNCTION gdk_region_copy ##### -->
-<para>
-
-</para>
-
-@region:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_region_rectangle ##### -->
-<para>
-
-</para>
-
-@rectangle:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_region_destroy ##### -->
-<para>
-
-</para>
-
-@region:
-
-
-<!-- ##### FUNCTION gdk_region_get_clipbox ##### -->
-<para>
-
-</para>
-
-@region:
-@rectangle:
-
-
-<!-- ##### FUNCTION gdk_region_get_rectangles ##### -->
-<para>
-
-</para>
-
-@region:
-@rectangles:
-@n_rectangles:
-
-
-<!-- ##### FUNCTION gdk_region_empty ##### -->
-<para>
-
-</para>
-
-@region:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_region_equal ##### -->
-<para>
-
-</para>
-
-@region1:
-@region2:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_region_rect_equal ##### -->
-<para>
-
-</para>
-
-@region:
-@rectangle:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_region_point_in ##### -->
-<para>
-
-</para>
-
-@region:
-@x:
-@y:
-@Returns:
-
-
-<!-- ##### FUNCTION gdk_region_rect_in ##### -->
-<para>
-
-</para>
-
-@region:
-@rectangle:
-@Returns:
-
-
-<!-- ##### ENUM GdkOverlapType ##### -->
-<para>
-Specifies the possible values returned by gdk_region_rect_in().
-</para>
-
-@GDK_OVERLAP_RECTANGLE_IN: if the rectangle is inside the #GdkRegion.
-@GDK_OVERLAP_RECTANGLE_OUT: if the rectangle is outside the #GdkRegion.
-@GDK_OVERLAP_RECTANGLE_PART: if the rectangle is partly inside the #GdkRegion.
-
-<!-- ##### FUNCTION gdk_region_offset ##### -->
-<para>
-
-</para>
-
-@region:
-@dx:
-@dy:
-
-
-<!-- ##### FUNCTION gdk_region_shrink ##### -->
-<para>
-
-</para>
-
-@region:
-@dx:
-@dy:
-
-
-<!-- ##### FUNCTION gdk_region_union_with_rect ##### -->
-<para>
-
-</para>
-
-@region:
-@rect:
-
-
-<!-- ##### FUNCTION gdk_region_intersect ##### -->
-<para>
-</para>
-
-@source1:
-@source2:
-
-
-<!-- ##### FUNCTION gdk_region_union ##### -->
-<para>
-
-</para>
-
-@source1:
-@source2:
-
-
-<!-- ##### FUNCTION gdk_region_subtract ##### -->
-<para>
-</para>
-
-@source1:
-@source2:
-
-
-<!-- ##### FUNCTION gdk_region_xor ##### -->
-<para>
-</para>
-
-@source1:
-@source2:
-
-
-<!-- ##### 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: 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: a #GdkSpan.
-@data: the user data passed to gdk_region_spans_intersect_foreach().
-
-
-<!-- ##### FUNCTION gdk_region_spans_intersect_foreach ##### -->
-<para>
-
-</para>
-
-@region:
-@spans:
-@n_spans:
-@sorted:
-@function:
-@data:
-
-