-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
WebGL mode documentation improvements #6167
Merged
+19
−2
Merged
Changes from 7 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
1d6068d
add basic feature list and links as a summary for webgl mode docs
wong-justin 9d96c21
Merge remote-tracking branch 'upstream/main' into webgl-inline-docs
wong-justin 17936c8
use markdown bold instead of html bold
wong-justin a2ef21d
intro sentences more descriptive + simplified
wong-justin 29a700d
format list items as: topic, then sentence(s) with links
wong-justin 84985f3
ending references seem nicer as a sentence instead of 2 list items
wong-justin f1a00c6
add line() WEBGL example
wong-justin 021c565
label z-params as WEBGL mode
wong-justin 004ac1d
remove unused documentation
wong-justin f4b3a9c
Revert "remove unused documentation"
wong-justin eed99e6
add comment about documentation not being generated
wong-justin 9dbe1c2
add webgl example using detail param for arc()
wong-justin 346e0a4
Merge remote-tracking branch 'upstream/main' into webgl-inline-docs
wong-justin 30d6fd4
style line() 3d example as xyz gizmo
wong-justin 2fafba9
add shape detail to webgl feature list
wong-justin 699c922
Revert "style line() 3d example as xyz gizmo"
wong-justin 04f8763
Revert "add webgl example using detail param for arc()"
wong-justin 994d18f
Revert "label z-params as WEBGL mode"
wong-justin 57f3a96
Revert "add line() WEBGL example"
wong-justin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The other code examples only used the x and y parameters for line(), so I added one using the z parameters for WEBGL mode.
I figure it's a good goal to show all the possible parameters in the code examples, which would mean having a 3D example for the 2D primitives.
Having these scaffolded examples might naturally help users transition to WEBGL. Eg. they might know the WEBGL coordinate system is different just from their time browsing 2D primitives examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree, it's nice to see the webGL versions with the updated signatures! If we don't think it's too much code I think it could be nice to color these lines in rgb (xyz) gizmo fashion like so https://editor.p5js.org/aferriss/sketches/qCsZ08lJ8