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.

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

Reorganize and improve shader Uniforms section #10261

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tetrapod00
Copy link
Contributor

The shader uniforms section has gotten very long and disordered, with bits of it seemingly split up by unrelated notes. This PR reorganizes it, adds subheaders, and makes some other minor improvements. The text itself is mostly unchanged.

The new order is:

  • Uniforms (which links to Setting uniforms from code)
    • Uniform hints
      • Info
      • Uniform hint table
      • Source color note
    • Uniform groups
    • Global uniforms
    • Per-instance uniforms
    • Setting uniforms from code
      • Info
      • GDScript to shader data type equivalences
    • Uniform limits (formerly a note)

The only thing I'm unsure about is whether Setting uniforms from code should be the very first subheader, or where it is now. It makes sense to mention how to set uniforms from the inspector or from code early, BUT that section has a very long table so I think near the end is better. As a compromise, I linked to the section from the first Uniforms section.

@tetrapod00 tetrapod00 added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:shaders labels Nov 14, 2024
@tetrapod00
Copy link
Contributor Author

Not a cherrypick because it depends on #10119 which is not a cherrypick

@tetrapod00
Copy link
Contributor Author

Updated to take the recently merged hint_enum docs into account, and mildly improved those at the same time.

@tetrapod00
Copy link
Contributor Author

tetrapod00 commented Nov 23, 2024

Rebased and removed the new content, which is now in a separate PR. Hopefully this no longer needs a deep review from an area maintainer, since it's now just reorganization and wording improvements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:shaders
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants