-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
Adding example code for compute shaders #6159
Adding example code for compute shaders #6159
Conversation
Hey there @Calinou sorry for the inconvenience the previous version was broken. For a first version I am happy with the outcome but unfortunately english is not my main language so I hope there are some nice ones who could proofread my tutorial. I could also attach some images or the final code, but I don't know what the process here is :) Thx for taking your time |
d8c39f2
to
dcd793a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great start! I have made many language suggestions and clarifications. Please let me know if the suggested changes make sense or if you have any questions for me.
f40b042
to
7c2bdf9
Compare
@clayjohn thanks a lot for your suggestions as you may noticed I tried my best, but my english is not the best. I committed your suggetsions and sqashed the changes another time. Please have another look <3 |
From someone who is probably the target audience, I'll suggest the presence of Additional Resources. Like "next steps" after the reader understands your tutorial. If you've noted some gems out on the web that have helped you wrap your head around when to use and how to win with compute shaders, I'd like to find them here. For one thing, if there are limitations to how Godot handles CS, the resources I find in a web search could lead me astray because they're not considering those limitations. For examples of Additional Resources, see the youtube links at the end section of Matrices and Transforms. Resources could accumulate near the end, like that example, or appear beside relevant text. (Godot Docs has a Tutorials and Resources section, but I think the CS topic is too specific for that page) Great work on this! I think you're adding a vital piece of documentation for Godot 4. |
7c2bdf9
to
efc9799
Compare
Thanks for your opinion @Dayrook unfortunately there are no tutorials out yet so they can't be included in this PR. |
I didn't mean Godot CS tutorials. Here's an example of what I mean:
Stuff like that would give the reader good places to dig deeper once they've absorbed your tutorial. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking pretty good now! I have made a few more suggestions that I missed on the last round of reviews
4a960e1
to
245544f
Compare
Thanks a lot for all of your suggestions I merged them and squashed the commits again :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it looks great now! Thank you
@clayjohn who is responsible to merge this PR? I don't have rights to do so myself |
@dotlogix Several people can merge commits. Master of commit mergers is Rémi aka @akien-mga |
@dotlogix To add to what paddy-exe said. One of the other Documentation team members will give this a brief review and merge it if they don't find issues that I missed. There should be no need for action on your part unless someone else requests changes |
Thank you - congrats on your first docs contribution, and it's a sizeable one at that! 🎉 |
Hey there this is my first contribution to godot :)
Lately I used compute shaders and was missing some documentation, so I decided to write one after I understood how it works by trial and error.
Please ahave a look and give me suggestions how to improve the documentation.
If this one works out I would like to add also more advanced tutorials for other use cases.