star-cpr

commit 2835f6ee3193cd1914f71daa53780630fc1b0f34
parent 0221804610d6d6e17df8ccfa0c6af99d1c04dd92
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Tue,  4 Oct 2022 18:38:47 +0200

Add a note on polygon inside/outside in header file

Diffstat:
M
src/scpr.h
 | 
4
++++

1 file changed, 4 insertions(+), 0 deletions(-)
diff --git a/src/scpr.h b/src/scpr.h
@@ -58,6 +58,10 @@ struct scpr_mesh;
 
 BEGIN_DECLS
 
+/* Polygons can be made of any number of paths.
+ * Polygons inside/outside regions are defined by their winding numbers
+ * considering the Even-Odd convention.
+ * E.g. a CCW polygon inside a CW one defines a hole. */
 SCPR_API res_T
 scpr_polygon_create
   (struct mem_allocator* allocator, /* May be NULL <=> Use default allocator */