File: tickit_rectset_contains.3

package info (click to toggle)
libtickit 0.4.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,556 kB
  • sloc: ansic: 13,904; perl: 228; makefile: 161; sh: 38
file content (20 lines) | stat: -rw-r--r-- 739 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
.TH TICKIT_RECTSET_CONTAINS 3
.SH NAME
tickit_rectset_contains \- test if an area is contained by a rectangle set
.SH SYNOPSIS
.EX
.B #include <tickit.h>
.sp
.BI "bool tickit_rectset_contains(const TickitRectSet *" trs ", const TickitRect *" rect );
.EE
.sp
Link with \fI\-ltickit\fP.
.SH DESCRIPTION
\fBtickit_rectset_contains\fP() tests whether the area given by \fIrect\fP is entirely contained by one or more regions in the rectangle set.
.SH "RETURN VALUE"
\fBtickit_rectset_contains\fP() returns a true value if the given area is entirely covered by one or more regions, or false if at least some portion of it remains uncovered.
.SH "SEE ALSO"
.BR tickit_rectset_new (3),
.BR tickit_rectset (7),
.BR tickit_rect (7),
.BR tickit (7)