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

Adding example code for compute shaders

Open dotlogix opened this issue 3 years ago • 2 comments

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.

dotlogix avatar Sep 09 '22 16:09 dotlogix

Hey there @Calinou sorry for the inconvenience the previous version was broken. I found a way to test it locally now :)

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

dotlogix avatar Sep 09 '22 19:09 dotlogix

@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. I also added a bit more information about accessing memory outside of your control.

Please have another look <3

dotlogix avatar Sep 19 '22 20:09 dotlogix

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.

Dayruke avatar Sep 21 '22 14:09 Dayruke

Thanks for your opinion @Dayrook unfortunately there are no tutorials out yet so they can't be included in this PR. In the near future I plan to create extended and more complex scenarios but don't know when I have time to do so :)

dotlogix avatar Sep 21 '22 17:09 dotlogix

I didn't mean Godot CS tutorials. Here's an example of what I mean:

More information on how memory is handled is available on the OpenGL Wiki Compute Shader article

Stuff like that would give the reader good places to dig deeper once they've absorbed your tutorial.

Dayruke avatar Sep 21 '22 17:09 Dayruke

This is looking pretty good now! I have made a few more suggestions that I missed on the last round of reviews

Thanks a lot for all of your suggestions I merged them and squashed the commits again :)

dotlogix avatar Sep 23 '22 13:09 dotlogix

@clayjohn who is responsible to merge this PR? I don't have rights to do so myself

dotlogix avatar Sep 25 '22 22:09 dotlogix

@dotlogix Several people can merge commits. Master of commit mergers is Rémi aka @akien-mga

paddy-exe avatar Sep 25 '22 22:09 paddy-exe

@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

clayjohn avatar Sep 26 '22 03:09 clayjohn

Thank you - congrats on your first docs contribution, and it's a sizeable one at that! 🎉

mhilbrunner avatar Oct 11 '22 05:10 mhilbrunner