godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

Documentation for shader built-in include files

Open Jackerty opened this issue 10 months ago • 12 comments

Documents merged feature godotengine/godot#94193 to the end of the compute shader tutorial.

If someone has a better example in mind I'm open to suggestions. I just wanted something short that does not have too much extra code around the include.

Jackerty avatar Feb 21 '25 20:02 Jackerty

Are you running your non-code text for this PR through a translator?

skyace65 avatar Feb 26 '25 02:02 skyace65

I do run them through (freemium) Grammarly...

Jackerty avatar Feb 26 '25 15:02 Jackerty

To be clear, can I fix that CI error or should I wait?

Jackerty avatar Feb 26 '25 18:02 Jackerty

Please fix CI errors as soon as you can!

fire avatar Feb 26 '25 18:02 fire

I don't think that CI error is caused by this PR

Jackerty avatar Feb 26 '25 18:02 Jackerty

For future reference

Run /home/runner/work/_actions/lycheeverse/lychee-action/v2/entrypoint.sh
   [WARN ] Error creating request: InvalidBaseJoin("_static/")
   [WARN ] Error creating request: InvalidBaseJoin("res://someresource.res::1")
Error:  https://webd97.de/post/gitlab-pages-compression/ | Network error: error sending request for url (https://webd97.de/post/gitlab-pages-compression/) Maybe a certificate error?
# Summary

| Status        | Count |
|---------------|-------|
| 🔍 Total      | 1633  |
| ✅ Successful | 893   |
| ⏳ Timeouts   | 0     |
| 🔀 Redirected | 0     |
| 👻 Excluded   | 739   |
| ❓ Unknown    | 0     |
| 🚫 Errors     | 1     |

## Errors per input

### Errors in tutorials/export/exporting_for_web.rst

Error: R] [https://webd97.de/post/gitlab-pages-compression/](https://webd97.de/post/gitlab-pages-compression/) | Network error: error sending request for url (https://webd97.de/post/gitlab-pages-compression/) Maybe a certificate error?

Error: Process completed with exit code 2.

Jackerty avatar Feb 26 '25 18:02 Jackerty

There is a broken link in exporting_for_web.rst. Making an issue.

Jackerty avatar Feb 26 '25 18:02 Jackerty

What I found -> #10717

Jackerty avatar Feb 26 '25 19:02 Jackerty

Took a while, but reworked the example to be a pulsating transparent circle. The proposal now explains better what the example code does.

Jackerty avatar Mar 29 '25 07:03 Jackerty

At first glance, looks like a nice example for showing how shader includes work.

I wonder if we should make more examples, or at least reference this once its merged: https://github.com/godotengine/godot-demo-projects/pull/1086

There are plans to further break up and add built-in include files for our shader template logic. Those improvements will also unlock some interesting options with compositor effects. That is likely future music though but worth keeping in the back of our heads.

BastiaanOlij avatar Apr 25 '25 23:04 BastiaanOlij

One example is enough for now, just to get the feature documented in the first place.

Examples are nice and all, but I would suggest that the bigger problem is how to know what includes have in them. For example, the manual's description of RenderSceneData does not mention about previous frame's data or the number of views or what member fields exist. The only info for them was your demo example.

I was thinking if I could try some PRs on this, I don't know.

Jackerty avatar Apr 26 '25 08:04 Jackerty

@AThousandShips Thank you :)

Jackerty avatar Apr 26 '25 20:04 Jackerty