aboutsummaryrefslogtreecommitdiff
path: root/include/wlr
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2021-07-01 10:45:25 +0200
committerSimon Zeni <simon@bl4ckb0ne.ca>2021-07-05 09:25:25 -0400
commit82af6e720870e66a49c5e514468ffea71742b280 (patch)
tree1b9c89d1a9c50960a2403c24f0c2408b9b2a6641 /include/wlr
parent475d9701e21e5047ee9d7e56909762c1eb961fcd (diff)
region: stabilize interface
References: https://github.com/swaywm/wlroots/issues/1008
Diffstat (limited to 'include/wlr')
-rw-r--r--include/wlr/types/wlr_region.h26
1 files changed, 20 insertions, 6 deletions
diff --git a/include/wlr/types/wlr_region.h b/include/wlr/types/wlr_region.h
index 532f86df..45da8880 100644
--- a/include/wlr/types/wlr_region.h
+++ b/include/wlr/types/wlr_region.h
@@ -1,17 +1,31 @@
/*
- * This an unstable interface of wlroots. No guarantees are made regarding the
- * future consistency of this API.
+ * 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_USE_UNSTABLE
-#error "Add -DWLR_USE_UNSTABLE to enable unstable wlroots features"
-#endif
#ifndef WLR_TYPES_WLR_REGION_H
#define WLR_TYPES_WLR_REGION_H
#include <pixman.h>
-#include <wayland-server-protocol.h>
+struct wl_resource;
+
+/**
+ * Obtain a Pixman region from a wl_region resource.
+ *
+ * To allow clients to create wl_region objects, call wlr_compositor_create().
+ */
pixman_region32_t *wlr_region_from_resource(struct wl_resource *resource);
#endif