Skip to content

Update vector docs to indicate recommended usage #8783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ksen0 merged 3 commits into from
May 11, 2026
+4 −0
Merged

Update vector docs to indicate recommended usage #8783

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f775f4
Mark .array() as deprecated
ksen0 May 11, 2026
3d173f9
Clarify cross product docus
ksen0 May 11, 2026
93e304e
update to array() docsrtring
ksen0 May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/math/p5.Vector.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1372,6 +1372,9 @@ class Vector {
* The cross product is a vector that points straight out of the plane created
* by two vectors. The cross product's magnitude is the area of the parallelogram
* formed by the original two vectors.
*
* The cross product is defined on 3-dimensional vectors, and will use the `x`, `y`,
* and `z` components. This method should only be used with 3D vectors.
*
* The static version of `cross()`, as in `p5.Vector.cross(v1, v2)`, is the same
* as calling `v1.cross(v2)`.
Expand Down Expand Up @@ -2690,6 +2693,7 @@ class Vector {
* Returns the vector's components as an array of numbers.
*
* @return {Number[]} array with the vector's components.
* @deprecated To retrieve vector components, use `v.values`
* @example
* // META:norender
* function setup() {
Expand Down
Loading