---
name: "tickit_rectset_get_rect"
section: "3"
platform: "linux"
package: "libtickit-dev"
version: "0.4.3-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/tickit_rectset_get_rect"
---

# tickit\_rectset\_get\_rect(3)

obtain the regions from a rectangle set

## NAME

tickit\_rectset\_rects, tickit\_rectset\_get\_rects - obtain the regions from a rectangle set

## SYNOPSIS

```
#include <tickit.h>

size_t tickit_rectset_rects(const TickitRectSet *trs);
size_t tickit_rectset_get_rect(const TickitRectSet *trs,
    size_t i, TickitRect *rect);
size_t tickit_rectset_get_rects(const TickitRectSet *trs,
    TickitRect rects[], size_t n);
```

Link with *-ltickit*.

## DESCRIPTION

**tickit\_rectset\_rects**() returns the number of rectangular regions stored by the rectangle set.

**tickit\_rectset\_get\_rect**() copies the region representing the rectangle at index *i* into the variable pointed to by *rect*, and returns 1. If *i* is an invalid index for this set then 0 is returned instead.

**tickit\_rectset\_get\_rects**() copies at most *n* regions into the array given by *rects*, and returns the number of regions it copied (which may be fewer than the total stored, if the array was of insufficient size).

## RETURN VALUE

**tickit\_rectset\_rects**() returns an integer giving the number of stored regions. **tickit\_rectset\_get\_rect**() and **tickit\_rectset\_get\_rects**() return the number of regions copied.

## SEE ALSO

[**tickit\_rectset\_new**(3)](/tickit_rectset_new/3.md), [**tickit\_rectset**(7)](/tickit_rectset/7.md), [**tickit**(7)](/tickit/7.md)