.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::Gdk::Region 3"
.TH Gtk2::Gdk::Region 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Gtk2::Gdk::Region \- wrapper for GdkRegion
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Boxed
\&  +\-\-\-\-Gtk2::Gdk::Region
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "region = Gtk2::Gdk::Region\->\fBnew\fP"
.IX Subsection "region = Gtk2::Gdk::Region->new"
.ie n .SS "rectangle = $region\->\fBget_clipbox\fP"
.el .SS "rectangle = \f(CW$region\fP\->\fBget_clipbox\fP"
.IX Subsection "rectangle = $region->get_clipbox"
.ie n .SS "boolean = $region\->\fBempty\fP"
.el .SS "boolean = \f(CW$region\fP\->\fBempty\fP"
.IX Subsection "boolean = $region->empty"
.ie n .SS "boolean = $region1\->\fBequal\fP ($region2)"
.el .SS "boolean = \f(CW$region1\fP\->\fBequal\fP ($region2)"
.IX Subsection "boolean = $region1->equal ($region2)"
.IP \(bu 4
\&\f(CW$region2\fR (Gtk2::Gdk::Region)
.ie n .SS "$source1\->\fBintersect\fP ($source2)"
.el .SS "\f(CW$source1\fP\->\fBintersect\fP ($source2)"
.IX Subsection "$source1->intersect ($source2)"
.IP \(bu 4
\&\f(CW$source2\fR (Gtk2::Gdk::Region)
.ie n .SS "$region\->\fBoffset\fP ($dx, $dy)"
.el .SS "\f(CW$region\fP\->\fBoffset\fP ($dx, \f(CW$dy\fP)"
.IX Subsection "$region->offset ($dx, $dy)"
.IP \(bu 4
\&\f(CW$dx\fR (integer)
.IP \(bu 4
\&\f(CW$dy\fR (integer)
.ie n .SS "boolean = $region\->\fBpoint_in\fP ($x, $y)"
.el .SS "boolean = \f(CW$region\fP\->\fBpoint_in\fP ($x, \f(CW$y\fP)"
.IX Subsection "boolean = $region->point_in ($x, $y)"
.IP \(bu 4
\&\f(CW$x\fR (integer)
.IP \(bu 4
\&\f(CW$y\fR (integer)
.ie n .SS "region = Gtk2::Gdk::Region\->\fBpolygon\fP ($points_ref, $fill_rule)"
.el .SS "region = Gtk2::Gdk::Region\->\fBpolygon\fP ($points_ref, \f(CW$fill_rule\fP)"
.IX Subsection "region = Gtk2::Gdk::Region->polygon ($points_ref, $fill_rule)"
.IP \(bu 4
\&\f(CW$points_ref\fR (scalar)
.IP \(bu 4
\&\f(CW$fill_rule\fR (Gtk2::Gdk::FillRule)
.ie n .SS "boolean = $region\->\fBrect_equal\fP ($rectangle)"
.el .SS "boolean = \f(CW$region\fP\->\fBrect_equal\fP ($rectangle)"
.IX Subsection "boolean = $region->rect_equal ($rectangle)"
.IP \(bu 4
\&\f(CW$rectangle\fR (Gtk2::Gdk::Rectangle)
.PP
Since: gtk+ 2.18
.ie n .SS "overlaptype = $region\->\fBrect_in\fP ($rect)"
.el .SS "overlaptype = \f(CW$region\fP\->\fBrect_in\fP ($rect)"
.IX Subsection "overlaptype = $region->rect_in ($rect)"
.IP \(bu 4
\&\f(CW$rect\fR (Gtk2::Gdk::Rectangle)
.SS "region = Gtk2::Gdk::Region\->\fBrectangle\fP ($rectangle)"
.IX Subsection "region = Gtk2::Gdk::Region->rectangle ($rectangle)"
.IP \(bu 4
\&\f(CW$rectangle\fR (Gtk2::Gdk::Rectangle)
.ie n .SS "list = $region\->\fBget_rectangles\fP"
.el .SS "list = \f(CW$region\fP\->\fBget_rectangles\fP"
.IX Subsection "list = $region->get_rectangles"
Returns a list of rectangles (Gtk2::Gdk::Rectangle's), the area covered by the
region.
.ie n .SS "$region\->\fBshrink\fP ($dx, $dy)"
.el .SS "\f(CW$region\fP\->\fBshrink\fP ($dx, \f(CW$dy\fP)"
.IX Subsection "$region->shrink ($dx, $dy)"
.IP \(bu 4
\&\f(CW$dx\fR (integer)
.IP \(bu 4
\&\f(CW$dy\fR (integer)
.ie n .SS "$region\->\fBspans_intersect_foreach\fP ($spans_ref, $sorted, $func, $data=undef)"
.el .SS "\f(CW$region\fP\->\fBspans_intersect_foreach\fP ($spans_ref, \f(CW$sorted\fP, \f(CW$func\fP, \f(CW$data\fP=undef)"
.IX Subsection "$region->spans_intersect_foreach ($spans_ref, $sorted, $func, $data=undef)"
.IP \(bu 4
\&\f(CW$spans_ref\fR (scalar) arrayref of triples [$x1,$y1,$width1, \f(CW$x2\fR,$y2,$width2, ...]
.IP \(bu 4
\&\f(CW$sorted\fR (boolean)
.IP \(bu 4
\&\f(CW$func\fR (scalar)
.IP \(bu 4
\&\f(CW$data\fR (scalar)
.PP
Call \f(CW$function\fR for horizontal lines which intersect \f(CW$region\fR.
.PP
\&\f(CW$spans_ref\fR is an arrayref of x,y,width horizontal lines.  If
\&\f(CW$sorted\fR is true then they're assumed to be sorted by increasing y
coordinate (allowing a single pass across the region rectangles).
\&\f(CW$function\fR is called
.PP
.Vb 1
\&    &$function ($x, $y, $width, $data)
.Ve
.PP
for each portion of a span which intersects \f(CW$region\fR.  \f(CW$function\fR
must not change \f(CW$region\fR.
.PP
.Vb 8
\&    $region\->spans_intersect_foreach ([ 0,0,50, 20,20,100, 0,10,50 ],
\&                                      0, # spans not sorted by y
\&                                      \e&my_callback,
\&                                      \*(Aqhello\*(Aq);  # userdata
\&    sub my_callback {
\&      my ($x, $y, $width, $userdata) = @_;
\&      print "$userdata: $x, $y, $width\en";
\&    }
.Ve
.ie n .SS "$source1\->\fBsubtract\fP ($source2)"
.el .SS "\f(CW$source1\fP\->\fBsubtract\fP ($source2)"
.IX Subsection "$source1->subtract ($source2)"
.IP \(bu 4
\&\f(CW$source2\fR (Gtk2::Gdk::Region)
.ie n .SS "$source1\->\fBunion\fP ($source2)"
.el .SS "\f(CW$source1\fP\->\fBunion\fP ($source2)"
.IX Subsection "$source1->union ($source2)"
.IP \(bu 4
\&\f(CW$source2\fR (Gtk2::Gdk::Region)
.ie n .SS "$region\->\fBunion_with_rect\fP ($rect)"
.el .SS "\f(CW$region\fP\->\fBunion_with_rect\fP ($rect)"
.IX Subsection "$region->union_with_rect ($rect)"
.IP \(bu 4
\&\f(CW$rect\fR (Gtk2::Gdk::Rectangle)
.ie n .SS "$source1\->\fBxor\fP ($source2)"
.el .SS "\f(CW$source1\fP\->\fBxor\fP ($source2)"
.IX Subsection "$source1->xor ($source2)"
.IP \(bu 4
\&\f(CW$source2\fR (Gtk2::Gdk::Region)
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::Gdk::FillRule"
.IX Subsection "enum Gtk2::Gdk::FillRule"
.IP \(bu 4
\&'even\-odd\-rule' / 'GDK_EVEN_ODD_RULE'
.IP \(bu 4
\&'winding\-rule' / 'GDK_WINDING_RULE'
.SS "enum Gtk2::Gdk::OverlapType"
.IX Subsection "enum Gtk2::Gdk::OverlapType"
.IP \(bu 4
\&'in' / 'GDK_OVERLAP_RECTANGLE_IN'
.IP \(bu 4
\&'out' / 'GDK_OVERLAP_RECTANGLE_OUT'
.IP \(bu 4
\&'part' / 'GDK_OVERLAP_RECTANGLE_PART'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Boxed
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the LGPL.  See Gtk2 for a full notice.