Skip to content

docs: remove deprecated beginGeometry() and endGeometry() references #8642

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

Open
codervinitjangir wants to merge 4 commits into
base: dev-2.0
Choose a base branch
from
Open

docs: remove deprecated beginGeometry() and endGeometry() references #8642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb2d0d2
docs: remove broken links to beginGeometry/endGeometry in v2.0
codervinitjangir Mar 14, 2026
6770cb9
Merge remote-tracking branch 'upstream/dev-2.0' into fix/buildGeometr…
codervinitjangir Mar 17, 2026
a2adbaa
docs: resolve PR feedback - revert private docs and fix buildGeometry…
codervinitjangir Mar 17, 2026
3f6ce7c
Merge branch 'dev-2.0' into fix/buildGeometry-docs
codervinitjangir Mar 20, 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
29 changes: 1 addition & 28 deletions src/webgl/3d_primitives.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,6 @@ function primitives3D(p5, fn){
* The parameter, `callback`, is a function with the drawing instructions for
* the new <a href="#/p5.Geometry">p5.Geometry</a> object. It will be called
Copy link
Member

@ksen0 ksen0 Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change results in incomplete text:

Image

* once to create the new 3D shape.
*
* See <a href="#/p5/beginGeometry">beginGeometry()</a> and
* <a href="#/p5/endGeometry">endGeometry()</a> for another way to build 3D
* shapes.
*
* Note: `buildGeometry()` can only be used in WebGL mode.
*
* @method buildGeometry
Expand Down Expand Up @@ -321,12 +316,8 @@ function primitives3D(p5, fn){
* <a href="#/p5.Geometry">p5.Geometry</a> objects can contain lots of data
* about their vertices, surface normals, colors, and so on. Complex 3D shapes
* can use lots of memory which is a limited resource in many GPUs. Calling
* `freeGeometry()` can improve performance by freeing a
* <a href="#/p5.Geometry">p5.Geometry</a> object’s resources from GPU memory.
* `freeGeometry()` works with <a href="#/p5.Geometry">p5.Geometry</a> objects
* created with <a href="#/p5/beginGeometry">beginGeometry()</a> and
* <a href="#/p5/endGeometry">endGeometry()</a>,
* <a href="#/p5/buildGeometry">buildGeometry()</a>, and
* created with <a href="#/p5/buildGeometry">buildGeometry()</a> and
* <a href="#/p5/loadModel">loadModel()</a>.
*
* The parameter, `geometry`, is the <a href="#/p5.Geometry">p5.Geometry</a>
Expand All @@ -342,24 +333,6 @@ function primitives3D(p5, fn){
* @param {p5.Geometry} geometry 3D shape whose resources should be freed.
*
* @example
* function setup() {
* createCanvas(100, 100, WEBGL);
*
* background(200);
*
* // Create a p5.Geometry object.
* beginGeometry();
* cone();
* let shape = endGeometry();
*
* // Draw the shape.
* model(shape);
*
* // Free the shape's resources.
* freeGeometry(shape);
* }
*
* @example
* // Click and drag the mouse to view the scene from different angles.
*
* let button;
Expand Down
4 changes: 1 addition & 3 deletions src/webgl/loading.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -972,9 +972,7 @@ function loading(p5, fn){
* The parameter, `model`, is the
* <a href="#/p5.Geometry">p5.Geometry</a> object to draw.
* <a href="#/p5.Geometry">p5.Geometry</a> objects can be built with
* <a href="#/p5/buildGeometry">buildGeometry()</a>, or
* <a href="#/p5/beginGeometry">beginGeometry()</a> and
* <a href="#/p5/endGeometry">endGeometry()</a>. They can also be loaded from
* <a href="#/p5/buildGeometry">buildGeometry()</a>. They can also be loaded from
* a file with <a href="#/p5/loadGeometry">loadGeometry()</a>.
*
* Note: `model()` can only be used in WebGL mode.
Expand Down