Skip to content

Commit 63bc7fd

Browse files
committed
changes to reference docs
1 parent 5f2b825 commit 63bc7fd

23 files changed

+49
-49
lines changed

py5_docs/Reference/api_en/Py5Graphics_bezier_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = vertex
77

88
@@ signatures
9-
bezier_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
bezier_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of bezier vertex coordinates with 6 or 9 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of bezier vertex coordinates with 6 or 9 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Create a collection of bezier vertices. The purpose of this method is to provide an alternative to repeatedly calling [](py5graphics_bezier_vertex) in a loop. For a large number of bezier vertices, the performance of `bezier_vertices()` will be much faster.

py5_docs/Reference/api_en/Py5Graphics_curve_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = vertex
77

88
@@ signatures
9-
curve_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
curve_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of curve vertex coordinates with 2 or 3 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of curve vertex coordinates with 2 or 3 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Create a collection of curve vertices. The purpose of this method is to provide an alternative to repeatedly calling [](py5graphics_curve_vertex) in a loop. For a large number of curve vertices, the performance of `curve_vertices()` will be much faster.

py5_docs/Reference/api_en/Py5Graphics_lines.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = 2d_primitives
77

88
@@ signatures
9-
lines(coordinates: npt.NDArray[np.floating], /) -> None
9+
lines(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of line coordinates with 4 or 6 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of line coordinates with 4 or 6 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Draw a collection of lines to the Py5Graphics drawing surface. The purpose of this method is to provide an alternative to repeatedly calling [](py5graphics_line) in a loop. For a large number of lines, the performance of `lines()` will be much faster.

py5_docs/Reference/api_en/Py5Graphics_mask.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ processing_name = mask
88

99
@@ signatures
1010
mask(img: Py5Image, /) -> None
11-
mask(mask_array: npt.NDArray[np.integer], /) -> None
11+
mask(mask_array: Iterator[int], /) -> None
1212

1313
@@ variables
1414
img: Py5Image - image to use as the mask
15-
mask_array: npt.NDArray[np.integer] - 1D array of integers used as the alpha channel, needs to be the same length as the image's pixel array
15+
mask_array: Iterator[int] - 1D array of integers used as the alpha channel, needs to be the same length as the image's pixel array
1616

1717
@@ description
1818
Masks part of the Py5Graphics drawing surface from displaying by loading an image and using it as an alpha channel. This mask image should only contain grayscale data, but only the blue color channel is used. The mask image needs to be the same size as the image to which it is applied.

py5_docs/Reference/api_en/Py5Graphics_points.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = 2d_primitives
77

88
@@ signatures
9-
points(coordinates: npt.NDArray[np.floating], /) -> None
9+
points(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of point coordinates with 2 or 3 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of point coordinates with 2 or 3 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Draw a collection of points, each a coordinate in space at the dimension of one pixel. The purpose of this method is to provide an alternative to repeatedly calling [](py5graphics_point) in a loop. For a large number of points, the performance of `points()` will be much faster.

py5_docs/Reference/api_en/Py5Graphics_quadratic_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = vertex
77

88
@@ signatures
9-
quadratic_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
quadratic_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of quadratic vertex coordinates with 4 or 6 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of quadratic vertex coordinates with 4 or 6 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Create a collection of quadratic vertices. The purpose of this method is to provide an alternative to repeatedly calling [](py5graphics_quadratic_vertex) in a loop. For a large number of quadratic vertices, the performance of `quadratic_vertices()` will be much faster.

py5_docs/Reference/api_en/Py5Graphics_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = vertex
77

88
@@ signatures
9-
vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of vertex coordinates and optional UV texture mapping values
12+
coordinates: Iterator[Iterator[float]] - 2D array of vertex coordinates and optional UV texture mapping values
1313

1414
@@ description
1515
Create a collection of vertices. The purpose of this method is to provide an alternative to repeatedly calling [](py5graphics_vertex) in a loop. For a large number of vertices, the performance of `vertices()` will be much faster.

py5_docs/Reference/api_en/Py5Image_mask.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ processing_name = mask
88

99
@@ signatures
1010
mask(img: Py5Image, /) -> None
11-
mask(mask_array: npt.NDArray[np.integer], /) -> None
11+
mask(mask_array: Iterator[int], /) -> None
1212

1313
@@ variables
1414
img: Py5Image - image to use as the mask
15-
mask_array: npt.NDArray[np.integer] - 1D array of integers used as the alpha channel, needs to be the same length as the image's pixel array
15+
mask_array: Iterator[int] - 1D array of integers used as the alpha channel, needs to be the same length as the image's pixel array
1616

1717
@@ description
1818
Masks part of an image from displaying by loading another image and using it as an alpha channel. This mask image should only contain grayscale data, but only the blue color channel is used. The mask image needs to be the same size as the image to which it is applied.

py5_docs/Reference/api_en/Py5Shader_set.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ set(name: str, boolvec: JArray(JBoolean), ncoords: int, /) -> None
1111
set(name: str, mat: npt.NDArray[np.floating], /) -> None
1212
set(name: str, mat: npt.NDArray[np.floating], use3x3: bool, /) -> None
1313
set(name: str, tex: Py5Image, /) -> None
14+
set(name: str, vec: Iterator[float], /) -> None
15+
set(name: str, vec: Iterator[float], ncoords: int, /) -> None
16+
set(name: str, vec: Iterator[int], /) -> None
17+
set(name: str, vec: Iterator[int], ncoords: int, /) -> None
1418
set(name: str, vec: JArray(JBoolean), /) -> None
1519
set(name: str, vec: Py5Vector, /) -> None
16-
set(name: str, vec: npt.NDArray[np.floating], /) -> None
17-
set(name: str, vec: npt.NDArray[np.floating], ncoords: int, /) -> None
18-
set(name: str, vec: npt.NDArray[np.integer], /) -> None
19-
set(name: str, vec: npt.NDArray[np.integer], ncoords: int, /) -> None
2020
set(name: str, x: bool, /) -> None
2121
set(name: str, x: bool, y: bool, /) -> None
2222
set(name: str, x: bool, y: bool, z: bool, /) -> None
@@ -37,10 +37,10 @@ name: str - the name of the uniform variable to modify
3737
ncoords: int - number of coordinates per element, max 4
3838
tex: Py5Image - sets the sampler uniform variable to read from this image texture
3939
use3x3: bool - enforces the numpy array is 3 x 3
40+
vec: Iterator[float] - 1D numpy array of values to modify all the components of an array/vector uniform variable
41+
vec: Iterator[int] - 1D numpy array of values to modify all the components of an array/vector uniform variable
4042
vec: JArray(JBoolean) - modifies all the components of an array/vector uniform variable
4143
vec: Py5Vector - vector of values to modify all the components of an array/vector uniform variable
42-
vec: npt.NDArray[np.floating] - 1D numpy array of values to modify all the components of an array/vector uniform variable
43-
vec: npt.NDArray[np.integer] - 1D numpy array of values to modify all the components of an array/vector uniform variable
4444
w: bool - fourth component of the variable to modify. The variable has to be declared with an array/vector type in the shader (i.e.: int[4], vec4)
4545
w: float - fourth component of the variable to modify. The variable has to be declared with an array/vector type in the shader (i.e.: int[4], vec4)
4646
w: int - fourth component of the variable to modify. The variable has to be declared with an array/vector type in the shader (i.e.: int[4], vec4)

py5_docs/Reference/api_en/Py5Shape_bezier_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = vertices
66
subcategory = None
77

88
@@ signatures
9-
bezier_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
bezier_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of bezier vertex coordinates with 6 or 9 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of bezier vertex coordinates with 6 or 9 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Create a collection of bezier vertices. The purpose of this method is to provide an alternative to repeatedly calling [](py5shape_bezier_vertex) in a loop. For a large number of bezier vertices, the performance of `bezier_vertices()` will be much faster.

py5_docs/Reference/api_en/Py5Shape_curve_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = vertices
66
subcategory = None
77

88
@@ signatures
9-
curve_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
curve_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of curve vertex coordinates with 2 or 3 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of curve vertex coordinates with 2 or 3 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Create a collection of curve vertices. The purpose of this method is to provide an alternative to repeatedly calling [](py5shape_curve_vertex) in a loop. For a large number of curve vertices, the performance of `curve_vertices()` will be much faster.

py5_docs/Reference/api_en/Py5Shape_get_vertex_codes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ category = vertices
77
subcategory = None
88

99
@@ signatures
10-
get_vertex_codes() -> npt.NDArray[np.integer]
10+
get_vertex_codes() -> Iterator[int]
1111

1212
@@ description
1313
Get the vertex codes for a `Py5Shape` object. The vertex codes can be used to inspect a shape's geometry to determine what kind of vertices it has. Each can be one of `BREAK`, `VERTEX`, `BEZIER_VERTEX`, `QUADRATIC_VERTEX` or `CURVE_VERTEX`.

py5_docs/Reference/api_en/Py5Shape_quadratic_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = vertices
66
subcategory = None
77

88
@@ signatures
9-
quadratic_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
quadratic_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of quadratic vertex coordinates with 4 or 6 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of quadratic vertex coordinates with 4 or 6 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Create a collection of quadratic vertices. The purpose of this method is to provide an alternative to repeatedly calling [](py5shape_quadratic_vertex) in a loop. For a large number of quadratic vertices, the performance of `quadratic_vertices()` will be much faster.

py5_docs/Reference/api_en/Py5Shape_set_fills.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ subcategory = fill
55
type = method
66

77
@@ signatures
8-
set_fills(fills: npt.NDArray[np.int32], /) -> None
8+
set_fills(fills: Iterator[int], /) -> None
99

1010
@@ variables
11-
fills: npt.NDArray[np.int32] - array of fill colors
11+
fills: Iterator[int] - array of fill colors
1212

1313
@@ description
1414
Set the fill color for each of the individual vertices of a `Py5Shape`. The length of the passed `fills` array must equal the number of vertices in the shape. This method exists to provide an alternative to repeatedly calling [](py5shape_set_fill) in a loop.

py5_docs/Reference/api_en/Py5Shape_set_path.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ category = vertices
77
subcategory = None
88

99
@@ signatures
10-
set_path(vcount: int, verts: npt.NDArray[np.floating], /) -> None
10+
set_path(vcount: int, verts: Iterator[Iterator[float]], /) -> None
1111

1212
@@ variables
1313
vcount: int - number of vertices
14-
verts: npt.NDArray[np.floating] - 2D array of vertex coordinates
14+
verts: Iterator[Iterator[float]] - 2D array of vertex coordinates
1515

1616
@@ description
1717
Set many vertex points at the same time, using a numpy array. This will be faster and more efficient than repeatedly calling [](py5shape_set_vertex) in a loop. Setting the vertex codes is not supported, so the vertices will be regular vertices and not bezier, quadratic or curve vertices.

py5_docs/Reference/api_en/Py5Shape_set_strokes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ subcategory = stroke
55
type = method
66

77
@@ signatures
8-
set_strokes(strokes: npt.NDArray[np.int32], /) -> None
8+
set_strokes(strokes: Iterator[int], /) -> None
99

1010
@@ variables
11-
strokes: npt.NDArray[np.int32] - array of stroke colors
11+
strokes: Iterator[int] - array of stroke colors
1212

1313
@@ description
1414
Set the stroke color for each of the individual vertices of a `Py5Shape`. The length of the passed `strokes` array must equal the number of vertices in the shape. This method exists to provide an alternative to repeatedly calling [](py5shape_set_fill) in a loop.

py5_docs/Reference/api_en/Py5Shape_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = vertices
66
subcategory = None
77

88
@@ signatures
9-
vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of vertex coordinates and optional UV texture mapping values
12+
coordinates: Iterator[Iterator[float]] - 2D array of vertex coordinates and optional UV texture mapping values
1313

1414
@@ description
1515
Create a collection of vertices. The purpose of this method is to provide an alternative to repeatedly calling [](py5shape_vertex) in a loop. For a large number of vertices, the performance of `vertices()` will be much faster.

py5_docs/Reference/api_en/Sketch_bezier_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = vertex
77

88
@@ signatures
9-
bezier_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
bezier_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of bezier vertex coordinates with 6 or 9 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of bezier vertex coordinates with 6 or 9 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Create a collection of bezier vertices. The purpose of this method is to provide an alternative to repeatedly calling [](sketch_bezier_vertex) in a loop. For a large number of bezier vertices, the performance of `bezier_vertices()` will be much faster.

py5_docs/Reference/api_en/Sketch_curve_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = vertex
77

88
@@ signatures
9-
curve_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
curve_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of curve vertex coordinates with 2 or 3 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of curve vertex coordinates with 2 or 3 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Create a collection of curve vertices. The purpose of this method is to provide an alternative to repeatedly calling [](sketch_curve_vertex) in a loop. For a large number of curve vertices, the performance of `curve_vertices()` will be much faster.

py5_docs/Reference/api_en/Sketch_lines.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = 2d_primitives
77

88
@@ signatures
9-
lines(coordinates: npt.NDArray[np.floating], /) -> None
9+
lines(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of line coordinates with 4 or 6 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of line coordinates with 4 or 6 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Draw a collection of lines to the screen. The purpose of this method is to provide an alternative to repeatedly calling [](sketch_line) in a loop. For a large number of lines, the performance of `lines()` will be much faster.

py5_docs/Reference/api_en/Sketch_points.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = 2d_primitives
77

88
@@ signatures
9-
points(coordinates: npt.NDArray[np.floating], /) -> None
9+
points(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of point coordinates with 2 or 3 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - 2D array of point coordinates with 2 or 3 columns for 2D or 3D points, respectively
1313

1414
@@ description
1515
Draw a collection of points, each a coordinate in space at the dimension of one pixel. The purpose of this method is to provide an alternative to repeatedly calling [](sketch_point) in a loop. For a large number of points, the performance of `points()` will be much faster.

py5_docs/Reference/api_en/Sketch_quadratic_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = vertex
77

88
@@ signatures
9-
quadratic_vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
quadratic_vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of quadratic vertex coordinates with 4 or 6 columns for 2D or 3D points, respectively
12+
coordinates: Iterator[Iterator[float]] - missing variable description
1313

1414
@@ description
1515
Create a collection of quadratic vertices. The purpose of this method is to provide an alternative to repeatedly calling [](sketch_quadratic_vertex) in a loop. For a large number of quadratic vertices, the performance of `quadratic_vertices()` will be much faster.

py5_docs/Reference/api_en/Sketch_vertices.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ category = shape
66
subcategory = vertex
77

88
@@ signatures
9-
vertices(coordinates: npt.NDArray[np.floating], /) -> None
9+
vertices(coordinates: Iterator[Iterator[float]], /) -> None
1010

1111
@@ variables
12-
coordinates: npt.NDArray[np.floating] - 2D array of vertex coordinates and optional UV texture mapping values
12+
coordinates: Iterator[Iterator[float]] - 2D array of vertex coordinates and optional UV texture mapping values
1313

1414
@@ description
1515
Create a collection of vertices. The purpose of this method is to provide an alternative to repeatedly calling [](sketch_vertex) in a loop. For a large number of vertices, the performance of `vertices()` will be much faster.

0 commit comments

Comments
 (0)