Add support for the debug utils extension in OpenXR #95156
Conversation
|
cc @dsnopek, I tested this with the Meta XR Simulator, so far only got feedback from verbose messages (and flooded the logs :P) but will be useful with further testing. |
BastiaanOlij
force-pushed
the
add_openxr_debug_utils
branch
from
4fe9a79 to
5d81ff9
Compare
BastiaanOlij
force-pushed
the
add_openxr_debug_utils
branch
3 times, most recently
from
623ef95 to
57e8725
Compare
|
Ok, debug label support is in as well. Just needs a few small tweaks. However there is a bug when using Metas XR simulator, it seems to require us to not free memory of the labels we provide. This is likely a bug on their side but not ruling anything out just yet. |
| if (debug_utils_ext) { | ||
| set_object_name(XR_OBJECT_TYPE_SESSION, uint64_t(p_instance), "Main Godot OpenXR Session"); | ||
|
|
||
| begin_debug_label_region("Godot session active"); |
There was a problem hiding this comment.
Does this extension need to be invoked first before all the others?
There was a problem hiding this comment.
After catching up with the code in openxr_api, it looks this should be invoked from openxr_api instead to ensure it runs before all the other extensions. Same thing for set_object_name in on_instance_created
There was a problem hiding this comment.
We can't, because at that point we haven't initialised it yet, it leads to a nice crash :P
We'd need some way to give priority to this extension over all the other extensions so it runs first.
There was a problem hiding this comment.
Owh this is the session call, I mixed up with instance because the parameter name is wrong, oops :) I'll fix that up.
I guess we could move it into openxr_api itself to ensure it runs ASAP.
There was a problem hiding this comment.
Ok changed this, but with the footnote that this requires a fix in the Meta XR Simulator before it works properly as the memory holding the string gets destroyed after the call ends.
BastiaanOlij
force-pushed
the
add_openxr_debug_utils
branch
2 times, most recently
from
02b1fca to
974b33c
Compare
BastiaanOlij
force-pushed
the
add_openxr_debug_utils
branch
2 times, most recently
from
7700dbe to
a4dee6c
Compare
BastiaanOlij
force-pushed
the
add_openxr_debug_utils
branch
from
a4dee6c to
d8a76c3
Compare
BastiaanOlij
force-pushed
the
add_openxr_debug_utils
branch
from
d8a76c3 to
08ffa5d
Compare
|
Thanks! |
Adds support for the debug utils extension in OpenXR.
This extension gives access to validation layers and getting further feedback from the XR runtime.
For supported platforms see: https://github.khronos.org/OpenXR-Inventory/extension_support.html#XR_EXT_debug_utils
For specification see: https://registry.khronos.org/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_debug_utils
Todos:
Note: This PR currently just logs the debug messages coming from the XR runtime and is thus mostly useful for finding faults while implementing new APIs. In the future we may want to investigate whether we can use the callbacks for profiling as well but that is out of scope for this PR.