KhronosGroup / KhronosGroup/OpenXR-Docs

Clarify semantic of top level user paths

Open
#29 2 comments 0 reactions 0 assignees View on GitHub
clarification synced to gitlab
Dominant language
Python
Stars
181
Forks
74
PR merge metrics
No merged PRs in 30d

Description

`xrGetCurrentInteractionProfile` takes a `topLevelUserPath` argument, which is not totally clear to me how it should look like in practice. My initial assumption would be a `/user path` (6.3.1) but it also states it needs to follow the device input subpath syntax, which starts to confuse me as the semantic of 'top level' is unknown to me in this context.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the specification text for xrGetCurrentInteractionProfile and section 6.3.1, focusing on the topLevelUserPath argument and the device input subpath syntax. Clarify the meaning of “top level” and show how the argument should be formed in practice. Done means the relationship between user paths and device input subpaths is unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.