Update description of shader variable TIME and add description to Fog, Particle, Sky, and Spatial shader pages #9734
+74
−46
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.
Added/changed description of
TIME
in CanvasItem, Fog, Particle, Sky, and Spatial shader pages. Description now links to other relevant docs pages. Added a label to the global uniform header of shading_languge.rst, so it can be cross referenced from elsewhere.I made some changes in addition to simply copying the existing description from CanvasItem shaders to the other pages. Should close #9725.
I wrote for a user who is new-ish to shaders, notices that
TIME
does not exactly match CPU time behavior, and finds any of the shader pages. Ideally they can come away the exact behavior of the built-inTIME
uniform, as well as a way to make their own if need be. I based this on my interactions with users in various discords who asked aboutTIME
.New description which appears on each shader page:
Old description, from the CanvasItem shader page:
Changes:
TIME
uniform.rollover
".If any of these changes break docs style, or are otherwise too much, I can revert to more minimal changes.
Also sent in godotengine/godot#95381, so that the link to the setting from the shader docs page doesn't point to an empty description.