docs: add inline reference for uniform* methods in p5.strands #8514
+511
−0
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.
Resolves #8439
Changes:
Added inline reference documentation for the
uniform*methods inp5.strands. These methods are used in strands shader callbacks to pass data from JavaScript into shader code, but previously had no reference pages.Documented methods:
uniformFloat()- single float value (includes 2 examples: with callback + manual setUniform)uniformInt()- integer valueuniformBool()- boolean toggleuniformVec2()- 2D vectoruniformVec3()- 3D vectoruniformVec4()- 4D vector (RGBA colors, etc.)uniformTexture()- texture sampling viagetTexture()Each entry includes a description, parameter/return info, usage examples, and notes about aliases (e.g.
uniformVector2(),uniformSampler2D()).npm run lintpasses