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

Incorrect/duplicate docs for XrDebugUtilsMessengerCallbackDataEXT.sessionLabels? #151

Closed
3b opened this issue Apr 17, 2023 · 3 comments
Closed
Labels
bug Something isn't working fix pending internally A fix is pending in the internal Khronos processes synced to gitlab A corresponding issue has been filed in the Khronos internal GitLab vendor-extension

Comments

@3b
Copy link

3b commented Apr 17, 2023

in 12.26.4. Session Labels in XrDebugUtilsMessengerCallbackDataEXT "Member Descriptions", sessionLabels is documented as

  • sessionLabels is a pointer to an array of XrDebugUtilsLabelEXT objects related to the detected issue. The array is roughly in order or importance, but the 0th element is always guaranteed to be the most important object for this message.

  • sessionLabels is NULL or a pointer to an array of XrDebugUtilsLabelEXT active in the current XrSession at the time the callback was triggered. Refer to Session Labels for more information.

First description looks like something that was accidentally left in after editing it into the second, since it refers to objects instead of labels and has wrong order. (order is later described as "The labels listed inside sessionLabels are organized in time order, with the most recently generated label appearing first, and the oldest label appearing last.").

Also, the objects description (and the incorrect sessionLabels) says "... roughly in order or importance" which should probably be "... roughly in order of importance"? Possibly also should mention the possibility of being NULL, since objectCount can be 0.

@rpavlik-bot rpavlik-bot added the synced to gitlab A corresponding issue has been filed in the Khronos internal GitLab label May 17, 2023
@rpavlik-bot
Copy link
Collaborator

An issue (number 2015) has been filed to correspond to this issue in the internal Khronos GitLab (Khronos members only: KHR:openxr/openxr#2015 ), to facilitate working group processes.

This GitHub issue will continue to be the main site of discussion.

@rpavlik
Copy link
Contributor

rpavlik commented Jun 8, 2023

Good catch. I agree with your interpretation. I've made an internal MR to correct this accordingly, which will appear in an upcoming patch release if approved by the relevant stakeholders.

@rpavlik rpavlik added bug Something isn't working vendor-extension good first issue Good for newcomers fix pending internally A fix is pending in the internal Khronos processes and removed good first issue Good for newcomers labels Jun 8, 2023
@rpavlik
Copy link
Contributor

rpavlik commented Jul 11, 2023

Fixed in 1.0.28, thanks for the report!

@rpavlik rpavlik closed this as completed Jul 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fix pending internally A fix is pending in the internal Khronos processes synced to gitlab A corresponding issue has been filed in the Khronos internal GitLab vendor-extension
Projects
None yet
Development

No branches or pull requests

3 participants