search

KhronosGroup / OpenXR-Docs

OpenXR Specification sources and related material
Other
143 stars 62 forks source link

Clarify the usage of xrGetGraphicsRequirements #79

Closed morallo closed 3 years ago

morallo commented 3 years ago

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<*>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.

CLAassistant commented 3 years ago

CLA assistant check
All committers have signed the CLA.

rpavlik-bot commented 3 years ago

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 commented 3 years ago

Thanks for this! I'm just going to slightly adjust the markup and add a changelog entry.