wlroots/include/wlr/util/region.h
Drew DeVault 211ae764fd Initial pass on API stability guarantees
This introduces -DWLR_USE_UNSTABLE and adds information regarding the
stability status to all headers. I started with a conservative set of
headers to mark as stable:

- types/wlr_matrix.h
- util/edges.h
- util/log.h
- util/region.h
- xcursor.h
2018-07-29 19:20:34 -04:00

52 lines
1.5 KiB
C

/*
* This is a stable interface of wlroots. Future changes will be limited to:
*
* - New functions
* - New struct members
* - New enum members
*
* Note that wlroots does not make an ABI compatibility promise - in the future,
* the layout and size of structs used by wlroots may change, requiring code
* depending on this header to be recompiled (but not edited).
*
* Breaking changes are announced by email and follow a 1-year deprecation
* schedule. Send an email to ~sircmpwn/wlroots-announce+subscribe@lists.sr.ht
* to receive these announcements.
*/
#ifndef WLR_UTIL_REGION_H
#define WLR_UTIL_REGION_H
#include <pixman.h>
#include <wayland-server.h>
/**
* Scales a region, ie. multiplies all its coordinates by `scale`.
*
* The resulting coordinates are rounded up or down so that the new region is
* at least as big as the original one.
*/
void wlr_region_scale(pixman_region32_t *dst, pixman_region32_t *src,
float scale);
/**
* Applies a transform to a region inside a box of size `width` x `height`.
*/
void wlr_region_transform(pixman_region32_t *dst, pixman_region32_t *src,
enum wl_output_transform transform, int width, int height);
/**
* Expands the region of `distance`. If `distance` is negative, it shrinks the
* region.
*/
void wlr_region_expand(pixman_region32_t *dst, pixman_region32_t *src,
int distance);
/*
* Builds the smallest possible region that contains the region rotated about
* the point (ox, oy).
*/
void wlr_region_rotated_bounds(pixman_region32_t *dst, pixman_region32_t *src,
float rotation, int ox, int oy);
#endif