The bool returned by GetPlayAreaSize and GetPlayAreaRect is undocumented.

Open Beginner friendly
#227 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
cpp
Domain
api, documentation

Research direction

Locate the declarations or reference documentation for GetPlayAreaSize and GetPlayAreaRect, then read how their boolean results are described. Document what true and false indicate, including the reported idle-headset behavior, so driver authors can interpret the results without experimentation.

Written by the indexing model from the issue text.

Description

Is false good or bad?

From experimentation true means it worked, but a developer can get an awful lot of false results from an idle headset before they figure that out, and it'd be good to have documented for driver authors.

Dominant language
C++
Stars
6.7k
Forks
1.3k
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ValveSoftware/openvr

All issues in ValveSoftware/openvr

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.