Clarify the usage of xrGetGraphicsRequirements #79
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was no reference to the requirement to call the `xrGet<*>GraphicsRequirements` methods from the graphics API extension in the xrCreateSession method definition. The fact that the names of the functions don't have a common prefix but the API name is added in the middle instead made it hard to find them just searching by the `xrGetGraphicsRequirements` method referenced in the XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING error code description.
|
|
|
An issue (number 1547) has been filed to correspond to this issue in the internal Khronos GitLab (Khronos members only: KHR:openxr/openxr#1547 ), to facilitate working group processes. This GitHub issue will continue to be the main site of discussion. |
rpavlik-bot
added
the
synced to gitlab
|
Thanks for this! I'm just going to slightly adjust the markup and add a changelog entry. |
rpavlik
approved these changes
May 10, 2021
rpavlik
added a commit
that referenced
this pull request
May 11, 2021
This release contains improved/clarified behavior for xrCreateInstance
and xrEnumerateInstanceProperties, a new multi-vendor extension, a new
vendor extension, and a collection of clarifications.
- Registry
- Add new XR_ERROR_RUNTIME_UNAVAILABLE error code, add
XR_ERROR_RUNTIME_UNAVAILABLE as a supported error code to
xrCreateInstance and xrEnumerateInstanceProperties, and remove
XR_ERROR_INSTANCE_LOST as a supported error code from
xrCreateInstance. (internal MR 2024, internal issue 1552,
OpenXR-SDK-Source/#177)
- Add XR_EXT_hand_joint_motion_range multi-vendor extension.
(internal MR 1995)
- Add XR_FB_swapchain_update_state vendor extension. (internal MR
1997)
- Fix missing XR_ERROR_INSTANCE_LOST return codes for extension
functions in XR_EXT_performance_settings, XR_EXT_debug_utils,
XR_EXT_conformance_automation, and XR_EXT_thermal_query.
(internal MR 2023, OpenXR-Docs/#10, internal issue 1256)
- Reserve extension 166 for working group use. (internal MR 2025)
- Specification
- Clarify use of xrRequestExitSession on platforms with managed
application lifecycle. (internal MR 1978)
- Clarify hand grip orientation Z semantics. (internal MR 2008)
- Clarify unordered swapchain usage flag meaning. (internal MR
2029, internal issue 1543)
- Clarify that hysteresis should be used when applying thresholds
to scalar input. (internal MR 2031, internal issue 1260,
OpenXR-Docs/#27)
- Document new multi-vendor extension
XR_EXT_hand_joint_motion_range - allows applications to request
specific motion ranges when using XR_EXT_hand_tracking.
(internal MR 1995)
- Document new XR_FB_swapchain_update_state vendor extension.
(internal MR 1997)
- Fix xml_consistency scripts to properly identify missing error
codes from handle ancestors, and suppress warnings about all
missing _LOST and _LOSS_PENDING on xrDestroy functions.
(internal MR 2023, OpenXR-Docs/#10, internal issue 1256)
- Modify language in XR_EXT_hand_tracking to explicitly state that
an “empty hand” range of motion is the default. (internal MR
1995)
- Session: Explicitly name the pattern for “get graphics
requirements” functions, and place a generic version of the
XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING return code text
from graphics extensions in the core spec. (OpenXR-Docs/#79,
internal issue 1547)
- Style guide: Update “Extensions” chapter to simplify and reflect
actual practice and policy. (internal MR 2027)
- Extension process document: Update to note the working group
policy on extending core/KHR bitmasks. (internal MR 2025)
- scripts: Have reflow.py identify a file’s current newline
convention, and reproduce it upon writing the output. (internal
MR 2028)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I thought it would be more useful to propose a specific wording than just creating an issue.
I have tried to write in the right syntax but I haven't tested the build.
There was no reference to the requirement to call the
xrGet<*>GraphicsRequirementsmethods from the graphics API extension in the xrCreateSession method definition.The fact that the names of the functions don't have a common prefix but the API name is added in the middle instead made it hard to find them just searching by the
xrGetGraphicsRequirementsmethod referenced in the XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING error code description.