Skip to content

Update reference for v11, fix locked version on p5 update #578

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.

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
merged 6 commits into from
Sep 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
763 changes: 554 additions & 209 deletions public/reference/data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/camera.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ description: >
the "up"

vector is <code>(0, 1, 0)</code>.</p>
line: 2764
line: 2765
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/centerX.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: >
"world" space, so

<code>myCamera.centerX</code> is 0.</p>
line: 1186
line: 1187
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/centerY.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: >
"world" space, so

<code>myCamera.centerY</code> is 0.</p>
line: 1299
line: 1300
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/centerZ.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: >
"world" space, so

<code>myCamera.centerZ</code> is 0.</p>
line: 1412
line: 1413
isConstructor: false
itemtype: property
example:
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Camera/eyeX.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ module: 3D
submodule: Camera
file: src/webgl/p5.Camera.js
description: |
<p>The camera’s y-coordinate.</p>
<p>By default, the camera’s y-coordinate is set to 0 in "world" space.</p>
line: 850
<p>The camera’s x-coordinate.</p>
<p>By default, the camera’s x-coordinate is set to 0 in "world" space.</p>
line: 851
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/eyeY.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ file: src/webgl/p5.Camera.js
description: |
<p>The camera’s y-coordinate.</p>
<p>By default, the camera’s y-coordinate is set to 0 in "world" space.</p>
line: 962
line: 963
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/eyeZ.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ file: src/webgl/p5.Camera.js
description: |
<p>The camera’s z-coordinate.</p>
<p>By default, the camera’s z-coordinate is set to 800 in "world" space.</p>
line: 1074
line: 1075
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/frustum.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ description: >
the

camera and the origin.</p>
line: 2273
line: 2274
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/lookAt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ description: >
<code>myCamera.lookAt(10, 20, 30)</code> points the camera at the coordinates

<code>(10, 20, 30)</code>.</p>
line: 2667
line: 2668
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/move.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: >
pixels to the right, 20 pixels down, and 30 pixels backward in its "local"

space.</p>
line: 2992
line: 2993
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/ortho.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ description: >
<code>far</code> are set to

0 and <code>max(width, height) + 800</code>, respectively.</p>
line: 2085
line: 2086
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/pan.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ description: >
<p>Note: Angles are interpreted based on the current

<a href="/reference/p5/angleMode/">angleMode()</a>.</p>
line: 2541
line: 2542
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/perspective.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ description: >
<code>10 * 800</code>,

which is 10 times the default distance between the camera and the origin.</p>
line: 1862
line: 1863
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/roll.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ description: >
<p>Note: Angles are interpreted based on the current

<a href="/reference/p5/angleMode/">angleMode()</a>.</p>
line: 2463
line: 2464
isConstructor: false
itemtype: method
alt: >-
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: >

<code>cam2.set(cam1)</code> will set <code>cam2</code> using
<code>cam1</code>’s configuration.</p>
line: 3243
line: 3244
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/setPosition.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: >

places the camera at coordinates <code>(10, 20, 30)</code> in "world"
space.</p>
line: 3089
line: 3090
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/slerp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ description: >
close to <code>cam1</code>’s.</p>

<p>Note: All of the cameras must use the same projection.</p>
line: 3320
line: 3321
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/tilt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ description: >
<p>Note: Angles are interpreted based on the current

<a href="/reference/p5/angleMode/">angleMode()</a>.</p>
line: 2604
line: 2605
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/upX.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |
<p>The x-component of the camera's "up" vector.</p>
<p>The camera's "up" vector orients its y-axis. By default, the "up" vector is
<code>(0, 1, 0)</code>, so its x-component is 0 in "local" space.</p>
line: 1525
line: 1526
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/upY.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |
<p>The y-component of the camera's "up" vector.</p>
<p>The camera's "up" vector orients its y-axis. By default, the "up" vector is
<code>(0, 1, 0)</code>, so its y-component is 1 in "local" space.</p>
line: 1636
line: 1637
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Camera/upZ.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |
<p>The z-component of the camera's "up" vector.</p>
<p>The camera's "up" vector orients its y-axis. By default, the "up" vector is
<code>(0, 1, 0)</code>, so its z-component is 0 in "local" space.</p>
line: 1747
line: 1748
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/addClass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Adds a class to the element.</p>
line: 2536
line: 2540
isConstructor: false
itemtype: method
example:
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/attribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ description: >
horizontal

alignment to <code>center</code>.</p>
line: 3257
line: 3261
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -80,12 +80,12 @@ return:
description: value of the attribute.
type: String
overloads:
- line: 3257
- line: 3261
params: []
return:
description: value of the attribute.
type: String
- line: 3312
- line: 3316
params:
- name: attr
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/center.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: >
is aligned

both vertically and horizontally.</p>
line: 2809
line: 2813
isConstructor: false
itemtype: method
example:
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/child.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: >
array of

children DOM nodes is returned.</p>
line: 2704
line: 2708
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -92,12 +92,12 @@ return:
description: an array of child nodes.
type: 'Node[]'
overloads:
- line: 2704
- line: 2708
params: []
return:
description: an array of child nodes.
type: 'Node[]'
- line: 2784
- line: 2788
params:
- name: child
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/draggable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: >

<code>myElement.draggable(otherElement)</code>, the other element will become
draggable.</p>
line: 3927
line: 3931
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/drop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ description: >

<a
href="https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/">DragEvent</a>.</p>
line: 3772
line: 3776
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/hasClass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Checks if a class is already applied to element.</p>
line: 2618
line: 2622
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/hide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Hides the current element.</p>
line: 3511
line: 3515
isConstructor: false
itemtype: method
example:
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/html.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: >
element's inner

HTML is returned.</p>
line: 2875
line: 2879
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -82,12 +82,12 @@ return:
description: the inner HTML of the element
type: String
overloads:
- line: 2875
- line: 2879
params: []
return:
description: the inner HTML of the element
type: String
- line: 2944
- line: 2948
params:
- name: html
description: |
Expand Down
14 changes: 7 additions & 7 deletions src/content/reference/en/p5.Element/position.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ description: >
returns

the element's position in an object, as in <code>{ x: 0, y: 0 }</code>.</p>
line: 2962
line: 2966
isConstructor: false
itemtype: method
example:
- |-

<div>
<code class='norender'>
<div class='norender'>
<code>
function setup() {
let cnv = createCanvas(100, 100);

Expand All @@ -50,8 +50,8 @@ example:
</code>
</div>

<div>
<code class='norender'>
<div class='norender'>
<code>
function setup() {
let cnv = createCanvas(100, 100);

Expand All @@ -70,12 +70,12 @@ return:
description: 'object of form `{ x: 0, y: 0 }` containing the element''s position.'
type: Object
overloads:
- line: 2962
- line: 2966
params: []
return:
description: 'object of form `{ x: 0, y: 0 }` containing the element''s position.'
type: Object
- line: 3013
- line: 3017
params:
- name: x
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/remove.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ file: src/dom/dom.js
description: |
<p>Removes the element, stops all audio/video streams, and removes all
callback functions.</p>
line: 3713
line: 3717
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/removeAttribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: >
<code>align</code>

attribute if it's been set.</p>
line: 3341
line: 3345
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/removeClass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Removes a class from the element.</p>
line: 2575
line: 2579
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/show.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Shows the current element.</p>
line: 3475
line: 3479
isConstructor: false
itemtype: method
example:
Expand Down
Loading