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

Add More Reminders to Free RID's #8447

Open
DevPoodle opened this issue Nov 11, 2023 · 0 comments · May be fixed by #10740
Open

Add More Reminders to Free RID's #8447

DevPoodle opened this issue Nov 11, 2023 · 0 comments · May be fixed by #10740
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement

Comments

@DevPoodle
Copy link

Your Godot version: 4.1

Issue description: Whenever a resource is created and identified with an RID, like when using RenderingServer or TextServer, it needs to be manually freed. While there's reminders to free them in the descriptions of functions that return RID's, there's a few more places I think should have reminders as well.

First, I think there should be a brief note at the end of the description of the RID class reference, reminding that the RID should be freed using whatever object created it. Second, in the compute shader tutorial, there's currently no information about freeing the shader's resources after it's completed running. I think there should at least be a note at the end about what resources need to be manually freed.

URL to the documentation page (if already existing):
RID Page: https://docs.godotengine.org/en/stable/classes/class_rid.html#class-rid
Compute Shader Tutorial: https://docs.godotengine.org/en/stable/tutorials/shaders/compute_shaders.html

@Piralein Piralein added area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement
Projects
None yet
2 participants