Skip to content

Commit afd38ef

Browse files
committed
document new parameter
1 parent b4c6cd4 commit afd38ef

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

py5_docs/Reference/api_en/Py5Shape_get_vertex_count.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,16 @@ processing_name = getVertexCount
88

99
@@ signatures
1010
get_vertex_count() -> int
11+
get_vertex_count(include_children: bool, /) -> int
12+
13+
@@ variables
14+
include_children: bool - include vertices in the shape's children
1115

1216
@@ description
1317
The `get_vertex_count()` method returns the number of vertices that make up a `Py5Shape`. In the example, the value 4 is returned by the `get_vertex_count()` method because 4 vertices are defined in `setup()`.
1418

19+
Use the `include_children` parameter to include the shape's children if the shape happens to be a `GROUP` shape. By default, a shape's children will not be included in the count.
20+
1521
@@ example
1622
def setup():
1723
global s

0 commit comments

Comments
 (0)