util: add docs for wlr_region_scale

1 files changed, 6 insertions, 0 deletions

diff --git a/include/wlr/util/region.h b/include/wlr/util/region.h
index 416adbf2..e268436b 100644
--- a/include/wlr/util/region.h
+++ b/include/wlr/util/region.h
@@ -3,6 +3,12 @@
 
 #include <pixman.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);