Merge pull request #35675 from Calinou/doc-2d-polygon-limits

Mention 2D polygon limits and how to increase them in the documentation
godotengine · Jan 28, 2020 · 6a5ffb8 · 6a5ffb8
2 parents 52abb74 + 8ea77b9
commit 6a5ffb8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml
@@ -5,6 +5,7 @@
 	</brief_description>
 	<description>
 		A line through several points in 2D space.
+		[b]Note:[/b] By default, Godot can only draw up to 4,096 polygon points at a time. To increase this limit, open the Project Settings and increase [member ProjectSettings.rendering/limits/buffers/canvas_polygon_buffer_size_kb] and [member ProjectSettings.rendering/limits/buffers/canvas_polygon_index_buffer_size_kb].
 	</description>
 	<tutorials>
 	</tutorials>

diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml
@@ -5,6 +5,7 @@
 	</brief_description>
 	<description>
 		A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture.
+		[b]Note:[/b] By default, Godot can only draw up to 4,096 polygon points at a time. To increase this limit, open the Project Settings and increase [member ProjectSettings.rendering/limits/buffers/canvas_polygon_buffer_size_kb] and [member ProjectSettings.rendering/limits/buffers/canvas_polygon_index_buffer_size_kb].
 	</description>
 	<tutorials>
 	</tutorials>