Skip to content

docs: clarify unit, coordinate system, and HID origin for LampInfo.Position and LampArray.BoundingBox #2552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: docs
Choose a base branch
from
Draft

docs: clarify unit, coordinate system, and HID origin for LampInfo.Position and LampArray.BoundingBox #2552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efe7ec6
Initial plan
Copilot Jul 27, 2026
74d0e2c
docs: add unit, coordinate system, and HID spec details to LampInfo.P…
Copilot Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions windows.devices.lights/lamparray_boundingbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,15 @@ The value of the bounding box.

Values are measured in meters.

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

Origin of [Positions](lampinfo_position.md) is the upmost, top, left corner of the box.

Bounding box extents are derived from the device's HID LampArray descriptor, which reports dimensions in micrometers (µm). The WinRT API converts these values to meters (µm ÷ 1,000,000).

## -examples

:::row:::
Expand Down
13 changes: 11 additions & 2 deletions windows.devices.lights/lampinfo_position.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,23 @@ public Vector3 Position { get; }
# Windows.Devices.Lights.LampInfo.Position

## -description
3D position of the lamp relative to the origin of the bounding-box.
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.

## -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).

## -remarks
Position values are expressed in meters. The coordinate system is left-handed:
- **+X** extends to the right.
- **+Y** extends downward.
- **+Z** extends away from the user (into the device).

The origin (0, 0, 0) corresponds to the front-top-left corner of the device's bounding box (see [LampArray.BoundingBox](lamparray_boundingbox.md)).

Position values are derived from the device's HID LampArray descriptor, which reports positions in micrometers (µm). The WinRT API converts these values to meters (µm ÷ 1,000,000) before exposing them as a [Vector3](/dotnet/api/system.numerics.vector3).

## -see-also
[LampArray.BoundingBox](lamparray_boundingbox.md), [Lighting and Illumination (www.usb.org)](https://www.usb.org/sites/default/files/hutrr84_-_lighting_and_illumination_page.pdf), [Dynamic lighting](/windows/uwp/devices-sensors/lighting-dynamic-lamparray)

## -examples