1TICKIT_RECTSET_RECTS(3)    Library Functions Manual    TICKIT_RECTSET_RECTS(3)
2
3
4

NAME

6       tickit_rectset_rects,  tickit_rectset_get_rects  -  obtain  the regions
7       from a rectangle set
8

SYNOPSIS

10       #include <tickit.h>
11
12       size_t tickit_rectset_rects(const TickitRectSet *trs);
13       size_t tickit_rectset_get_rect(const TickitRectSet *trs,
14           size_t i, TickitRect *rect);
15       size_t tickit_rectset_get_rects(const TickitRectSet *trs,
16           TickitRect rects[], size_t n);
17
18       Link with -ltickit.
19

DESCRIPTION

21       tickit_rectset_rects() returns the number of rectangular regions stored
22       by the rectangle set.
23
24       tickit_rectset_get_rect()  copies the region representing the rectangle
25       at index i into the variable pointed to by rect, and returns 1. If i is
26       an invalid index for this set then 0 is returned instead.
27
28       tickit_rectset_get_rects()  copies  at  most  n  regions into the array
29       given by rects, and returns the number of regions it copied (which  may
30       be fewer than the total stored, if the array was of insufficient size).
31

RETURN VALUE

33       tickit_rectset_rects()  returns  an integer giving the number of stored
34       regions.   tickit_rectset_get_rect()   and   tickit_rectset_get_rects()
35       return the number of regions copied.
36

SEE ALSO

38       tickit_rectset_new(3), tickit_rectset(7), tickit(7)
39
40
41
42                                                       TICKIT_RECTSET_RECTS(3)