浏览代码

Merge pull request #47242 from sygi/bitmap-opaque-polygons

Bitmap opaque_to_polygons documentation
Rémi Verschelde 4 年之前
父节点
当前提交
243be93087
共有 1 个文件被更改,包括 6 次插入0 次删除
  1. 6 0
      doc/classes/BitMap.xml

+ 6 - 0
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">