diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-06-11 23:44:47 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-11 23:44:47 +0200 |
| commit | 243be9308750c0ab1bef337b9cde005e644a2904 (patch) | |
| tree | 69eb868a1d6f136e22013fe38d6a66b3ad0d6a40 | |
| parent | 1b943dbea17f51be9eae50df4b9d45bb7a7e46a5 (diff) | |
| parent | a74791ed68c38b0ed429c238427e5197eb9f951e (diff) | |
Merge pull request #47242 from sygi/bitmap-opaque-polygons
Bitmap opaque_to_polygons documentation
| -rw-r--r-- | doc/classes/BitMap.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 27ead07e6f..83e598d2ba 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -71,6 +71,12 @@ <argument index="1" name="epsilon" type="float" default="2.0"> </argument> <description> + Creates an [Array] of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a [PackedVector2Array] of its vertices. + To get polygons covering the whole bitmap, pass: + [codeblock] + Rect2(Vector2(), get_size()) + [/codeblock] + [code]epsilon[/code] is passed to RDP to control how accurately the polygons cover the bitmap: a lower [code]epsilon[/code] corresponds to more points in the polygons. </description> </method> <method name="set_bit"> |