Skip to content

fix: correct textToContours and textToModel reference documentation (#8623) #8626

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
gourijain029-del wants to merge 1 commit into
base: dev-2.0
Choose a base branch
from
+21 −1
Open

fix: correct textToContours and textToModel reference documentation (#8623) #8626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 10 additions & 1 deletion src/type/p5.Font.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ export class Font {
* coordinates of the bounding box's bottom-left corner. See
* <a href="#/p5/textAlign">textAlign()</a> for more ways to align text.
*
* The fourth parameter, `options`, is also optional. `font.textToPoints()`
* The fourth parameter, `options`, is also optional. `font.textToContours()`
* expects an object with the following properties:
*
* `sampleFactor` is the ratio of the text's path length to the number of
Expand Down Expand Up @@ -373,6 +373,15 @@ export class Font {
*
* The generated model (a Geometry object) can be manipulated further—rotated, scaled,
* or styled with shaders—to create engaging, interactive visual art.
*
* The `options` parameter is also optional. `font.textToModel()` expects an object
* with the following properties:
*
* `extrude` is the depth to extrude the text. It defaults to 0. A value of 0 produces
* flat text; higher values create thicker, 3D models.
*
* `sampleFactor` is a factor controlling the level of detail for the text contours.
* It defaults to 1. Higher values result in smoother curves.
*
* @param {String} str The text string to convert into a 3D model.
* @param {Number} x The x-coordinate for the starting position of the text.
Expand Down