Add the names of the uniforms used by p5.js to the shader documentation
Open
Nobody has claimed this yet.
Area:Accessibility
Area:Core
Area:WebGL
Enhancement
- Dominant language
- JavaScript
- Stars
- 24k
- Forks
- 3.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 25
Description
Increasing Access
This would allow people creating shaders to better and more easily work with the p5.js framework.
Most appropriate sub-area of p5.js?
- Accessibility
- Color
- Core/Environment/Rendering
- Data
- DOM
- Events
- Image
- IO
- Math
- Typography
- Utilities
- WebGL
- Build Process
- Unit Testing
- Internalization
- Friendly Errors
- Other (specify if possible)
Feature enhancement details
For instance with colors and the matrices needed for 3d rendering, this would be really great for people who want to use the p5.js versions.
The list of uniforms would be added to https://p5js.org/learn/getting-started-in-webgl-shaders.html.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked p5.js WebGL shaders guide and review how shader uniforms are currently documented. Add the names of the p5.js uniforms, including those related to colors and 3D matrices, so shader authors can identify the framework-provided values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- computer-graphics, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100