docs: clarify unit, coordinate system, and HID origin for LampInfo.Position and LampArray.BoundingBox - #2552
Merged
John Kennedy (GrantMeStrength) merged 2 commits intoSep 16, 2026
Conversation
…osition and LampArray.BoundingBox
Copilot
AI
changed the title
[WIP] Fix missing unit specification for LampInfo.Position property
docs: clarify unit, coordinate system, and HID origin for LampInfo.Position and LampArray.BoundingBox
Jul 27, 2026
Copilot started reviewing on behalf of
John Kennedy (GrantMeStrength)
September 16, 2026 15:44
View session
John Kennedy (GrantMeStrength)
marked this pull request as ready for review
September 16, 2026 15:46
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documented axis directions and origin conflict with the LampArray/HID contract and must be corrected before approval.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
This pull request clarifies units, coordinate systems, origins, and HID provenance for LampArray spatial properties.
Changes:
- Documents
LampInfo.Positionvalues, axes, origin, and HID conversion. - Adds coordinate-system and HID-derived extent details to
LampArray.BoundingBox. - Adds related references.
File summaries
| File | Summary |
|---|---|
windows.devices.lights/lampinfo_position.md |
Documents position units, axes, origin, and HID conversion. |
windows.devices.lights/lamparray_boundingbox.md |
Documents bounding-box axes, origin, and HID-derived meter conversion. |
Review details
Suppressed comments (3)
windows.devices.lights/lamparray_boundingbox.md:29
- The handedness label conflicts with the axis directions documented here: +X to the right crossed with +Y downward points away from the user, which is the listed +Z direction, so these axes form a right-handed basis. Please reconcile the text with the API/HID contract (for example, change the label to right-handed or correct the +Z direction); the current combination will lead consumers to build incorrect 3D transforms.
The coordinate system is left-handed, with the origin at the front-top-left corner of the bounding box:
- **+X** extends to the right.
- **+Y** extends downward.
- **+Z** extends away from the user (into the device).
windows.devices.lights/lamparray_boundingbox.md:29
- This orientation block reverses the HID LampArray contract: the origin is the upmost, farthest, left-hand corner and the axes are X left-to-right, Y farthest-to-closest, and Z top-to-bottom. It also leaves the following origin sentence inconsistent. Please replace this new block and align/remove that sentence as part of the same correction.
The coordinate system is left-handed, with the origin at the front-top-left corner of the bounding box:
- **+X** extends to the right.
- **+Y** extends downward.
- **+Z** extends away from the user (into the device).
windows.devices.lights/lampinfo_position.md:14
- The HID LampArray contract does not use the front corner as the origin: it defines (0, 0, 0) at the upmost, farthest, left-hand corner of the bounding box. Calling this the front corner reverses the reference point for depth and makes the documented positions incompatible with the descriptor.
Gets the position of the lamp within the lamp array, expressed in meters relative to the front-top-left corner of the array's bounding box.
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## -property-value | ||
| The position of the lamp. | ||
| A [Vector3](/dotnet/api/system.numerics.vector3) representing the lamp's position in meters, where X is the horizontal offset (increasing to the right), Y is the vertical offset (increasing downward), and Z is the depth offset (increasing away from the user). |
This file contains hidden or 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
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.
LampInfo.PositionandLampArray.BoundingBoxlacked any specification of units, coordinate system handedness, axis orientation, or origin—forcing developers to reverse-engineer scale empirically.lampinfo_position.mdLampArray.BoundingBoxBoundingBox, HID spec, and Dynamic lighting docslamparray_boundingbox.md