util: add docs for wlr_region_scale

2018-01-25 21:54:51 +01:00 · 2018-01-25 21:54:51 +01:00 · a98ece68d3
parent 4223fbc763
commit a98ece68d3
1 changed files with 6 additions and 0 deletions
--- 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);