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

Improve warning messages related to Vulkan pipeline cache #80232

Merged

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Aug 4, 2023

This gives better explanations on why the cache may have been invalidated, along with usual consequences.

These messages have also been moved to verbose prints, as users cannot do anything to resolve them specifically (so they are mostly relevant to developers).

@chrisl8
Copy link
Contributor

chrisl8 commented Mar 25, 2024

The one thing I find missing in the new text is an explanation to the user of how to "fix" this. Typically when I see an error or warning, my instinct is that either I did something wrong and should fix it or there is a bug in the engine that I should track down and report, but this is purely informational and there is nothing for the user to do. I'm not sure the new text conveys that to a novice like me.

I think that the solution is to just wait? One could delete the .godot folder, but that would be too drastic, solving the problem but possibly causing other issues for the user.

I hate to make the error message more verbose, but adding something like, "No action is required, this will clear up on its own as Godot rebuilds its cache." or something like that might help.

EDIT: Or just stop showing this message entirely. I'm not sure what benefit it provides? I guess just explaining to a user who suddenly find something slow that it isn't Godot's fault?

Maybe the message should just say, "Generating new cache data due to GPU driver updates." and then at least we'd know what was happening, what the result might be, but that there was nothing to "do".

@Calinou
Copy link
Member Author

Calinou commented Mar 26, 2024

EDIT: Or just stop showing this message entirely. I'm not sure what benefit it provides?

This is what we discussed with @clayjohn recently. We could move the existing message to a verbose print, as users can't do much about it.

Work has been ongoing on reducing shader pipeline compilation stutter recently, so hopefully this will be less of a problem in the future anyway.

Edit: I've amended this PR to use print_verbose() instead of WARN_PRINT().

@Calinou Calinou force-pushed the vulkan-pipeline-cache-improve-messages branch from 7c15381 to 3f6d875 Compare March 26, 2024 21:41
This gives better explanations on why the cache may have been invalidated,
along with usual consequences.

These messages have also been moved to verbose prints, as users
cannot do anything to resolve them specifically (so they are mostly
relevant to developers).
@Calinou Calinou force-pushed the vulkan-pipeline-cache-improve-messages branch from 3f6d875 to 4a61592 Compare March 26, 2024 21:42
@akien-mga akien-mga modified the milestones: 4.x, 4.3 May 19, 2024
@akien-mga akien-mga merged commit 68ac4ee into godotengine:master May 20, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

@Calinou Calinou deleted the vulkan-pipeline-cache-improve-messages branch May 21, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants