Doc pass for Shaders in v8 #9789
Merged
Conversation
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 shader docs - add filter docs - add BindGroup docs - add UniformGroup docs
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 36f85c2:
|
Shader doc changes
Zyie
approved these changes
Oct 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
馃 Generated by Copilot at 877b25f
Summary
馃摑馃敡鈾伙笍
This pull request improves the naming, documentation, and encapsulation of various classes and types related to shaders, filters, and rendering with the GPU. It also adds a new script to the
package.jsonfile for generating documentation. The main goal of these changes is to make the code more readable, consistent, and safe for developers and users.Walkthrough
blendModeproperty of theFilterclass, changing "Sets" to "Get" to reflect the actual getter method (link)resolutionproperty of theFilterclass to 1, instead of using theFilter.defaultOptions.resolutionconstant, simplifying the code and avoiding unnecessary indirection (link)package.jsonfile that allows running the documentation generator with a file watcher, useful for developers who want to see the documentation updates as they edit the source code (link)