add doc

2025-03-14 02:59:42 +01:00 · 2019-07-02 15:35:57 +08:00 · 2019-07-02 15:35:57 +08:00 · 9b6c17ace4
commit 9b6c17ace4
parent 43f84ba478
3 changed files with 32 additions and 0 deletions
--- a/docs/images/lib2-px_circle-1.JPG
+++ b/docs/images/lib2-px_circle-1.JPG
--- a/docs/images/lib2-px_circle-2.JPG
+++ b/docs/images/lib2-px_circle-2.JPG
--- a/docs/lib2-px_circle.md
+++ b/docs/lib2-px_circle.md
@ -0,0 +1,32 @@
+# px_circle
+
+Returns points that can be used to draw a pixel-style circle.
+
+**Since:** 2.0
+
+## Parameters
+
+- `radius` : The circle radius.
+- `filled` : Default to `false`. Set it `true` if you want a filled circle.
+
+## Examples
+
+	include <pixel/px_circle.scad>;
+
+	for(pt = px_circle(10)) {
+		translate(pt)
+			square(1, center = true);
+	}
+
+![px_circle](images/lib2-px_circle-1.JPG)
+
+	include <pixel/px_circle.scad>;
+
+	for(pt = px_circle(10, filled = true)) {
+		translate(pt)
+			linear_extrude(1, scale = 0.5) 
+				square(1, center = true);
+	}
+		
+![px_circle](images/lib2-px_circle-2.JPG)
+