1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="libgimpbase-gimprectangle">
7
<refentrytitle role="top_of_page">gimprectangle</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
13
<refname>gimprectangle</refname>
14
<refpurpose></refpurpose>
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
18
<refsynopsisdiv role="synopsis">
19
<title role="synopsis.title">Synopsis</title>
25
<link linkend="gboolean">gboolean</link> <link linkend="gimp-rectangle-intersect">gimp_rectangle_intersect</link> (<link linkend="gint">gint</link> x1,
26
<link linkend="gint">gint</link> y1,
27
<link linkend="gint">gint</link> width1,
28
<link linkend="gint">gint</link> height1,
29
<link linkend="gint">gint</link> x2,
30
<link linkend="gint">gint</link> y2,
31
<link linkend="gint">gint</link> width2,
32
<link linkend="gint">gint</link> height2,
33
<link linkend="gint">gint</link> *dest_x,
34
<link linkend="gint">gint</link> *dest_y,
35
<link linkend="gint">gint</link> *dest_width,
36
<link linkend="gint">gint</link> *dest_height);
48
<refsect1 role="desc">
49
<title role="desc.title">Description</title>
55
<refsect1 role="details">
56
<title role="details.title">Details</title>
58
<title><anchor id="gimp-rectangle-intersect" role="function" condition="since:GIMP 2.4"/>gimp_rectangle_intersect ()</title>
59
<indexterm role="GIMP 2.4"><primary>gimp_rectangle_intersect</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_rectangle_intersect (<link linkend="gint">gint</link> x1,
60
<link linkend="gint">gint</link> y1,
61
<link linkend="gint">gint</link> width1,
62
<link linkend="gint">gint</link> height1,
63
<link linkend="gint">gint</link> x2,
64
<link linkend="gint">gint</link> y2,
65
<link linkend="gint">gint</link> width2,
66
<link linkend="gint">gint</link> height2,
67
<link linkend="gint">gint</link> *dest_x,
68
<link linkend="gint">gint</link> *dest_y,
69
<link linkend="gint">gint</link> *dest_width,
70
<link linkend="gint">gint</link> *dest_height);</programlisting>
72
Calculates the intersection of two rectangles.</para>
75
</para><variablelist role="params">
76
<varlistentry><term><parameter>x1</parameter> :</term>
77
<listitem><simpara> origin of first rectangle
78
</simpara></listitem></varlistentry>
79
<varlistentry><term><parameter>y1</parameter> :</term>
80
<listitem><simpara> origin of first rectangle
81
</simpara></listitem></varlistentry>
82
<varlistentry><term><parameter>width1</parameter> :</term>
83
<listitem><simpara> width of first rectangle
84
</simpara></listitem></varlistentry>
85
<varlistentry><term><parameter>height1</parameter> :</term>
86
<listitem><simpara> height of first rectangle
87
</simpara></listitem></varlistentry>
88
<varlistentry><term><parameter>x2</parameter> :</term>
89
<listitem><simpara> origin of second rectangle
90
</simpara></listitem></varlistentry>
91
<varlistentry><term><parameter>y2</parameter> :</term>
92
<listitem><simpara> origin of second rectangle
93
</simpara></listitem></varlistentry>
94
<varlistentry><term><parameter>width2</parameter> :</term>
95
<listitem><simpara> width of second rectangle
96
</simpara></listitem></varlistentry>
97
<varlistentry><term><parameter>height2</parameter> :</term>
98
<listitem><simpara> height of second rectangle
99
</simpara></listitem></varlistentry>
100
<varlistentry><term><parameter>dest_x</parameter> :</term>
101
<listitem><simpara> return location for origin of intersection (may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
102
</simpara></listitem></varlistentry>
103
<varlistentry><term><parameter>dest_y</parameter> :</term>
104
<listitem><simpara> return location for origin of intersection (may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
105
</simpara></listitem></varlistentry>
106
<varlistentry><term><parameter>dest_width</parameter> :</term>
107
<listitem><simpara> return location for width of intersection (may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
108
</simpara></listitem></varlistentry>
109
<varlistentry><term><parameter>dest_height</parameter> :</term>
110
<listitem><simpara> return location for height of intersection (may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
111
</simpara></listitem></varlistentry>
112
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the intersection is non-empty, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
114
</simpara></listitem></varlistentry>
115
</variablelist><para role="since">Since GIMP 2.4
added
removed
devel-docs/libgimpbase/xml/gimprectangle.xml
