Skip to content
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

Documentation Update:Webgl - .lib files not supported #7454

Merged
merged 8 commits into from
Jan 14, 2025
+5 −0
Merged

Documentation Update:Webgl - .lib files not supported #7454

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
96cc6f6
Documentation Update:Webgl - .lib files not supported
atmajaa Jan 3, 2025
b8bdc20
Documentation Update: Webgl - .lib files not supported
atmajaa Jan 6, 2025
d0715af
Update src/webgl/loading.js
davepagurek Jan 14, 2025
97e495f
Revert package-lock.json
davepagurek Jan 14, 2025
e13f48d
Revert package.json
davepagurek Jan 14, 2025
4d9a9d3
Merge branch 'main' into atmajaa/main
davepagurek Jan 14, 2025
e732dfa
Remove trailing space
davepagurek Jan 14, 2025
1aedfad
Remove another trailing space
davepagurek Jan 14, 2025
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
7 changes: 7 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.

3 changes: 3 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,5 +143,8 @@
"hooks": {
"pre-commit": "lint-staged"
}
},
"dependencies": {
"p5": "file:"
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we don't need these changes just to change the documentation. You can reset them with git checkout main -- package-lock.json package.json and then commit the results.

}
}
2 changes: 2 additions & 0 deletions src/webgl/loading.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ import './p5.Geometry';
* `loadModel('assets/model.obj')`. URLs such as
* `'https://example.com/model.obj'` may be blocked due to browser security.
*
* Note: Currently there is no support for `.lib` files. Only `.mtl` files are supported for defining materials.
Copy link
Contributor

Choose a reason for hiding this comment

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

Rather than just mentioning formats we don't support that users may not have heard of, maybe we can phrase this like, "if you are loading a .obj file that references materials stored in .mtl files, p5.js will try to load those materials." and maybe mention something about making sure you upload them alongside your obj if you want them to be read.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@davepagurek Thankyou for the feedback!
I have made the required changes. Let me know if any further modifications are required.

*
* The first way to call `loadModel()` has three optional parameters after the
* file path. The first optional parameter, `successCallback`, is a function
* to call once the model loads. For example,
Expand Down