XRRay
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The XRRay interface of the WebXR Device API is a geometric ray described by an origin point and a direction vector.
XRRay objects can be passed to XRSession.requestHitTestSource() or XRSession.requestHitTestSourceForTransientInput() to perform hit testing.
Constructor
XRRay()-
Creates a new
XRRayobject.
Instance properties
XRRay.directionRead only-
A
DOMPointReadOnlyrepresenting the ray's 3-dimensional directional vector. XRRay.matrixRead only-
A transform that can be used to position objects along the
XRRay. This is a 4 by 4 matrix given as a 16 elementFloat32Arrayin column major order. XRRay.originRead only-
A
DOMPointReadOnlyrepresenting the 3-dimensional point in space that the ray originates from, in meters.
Instance methods
None.
Examples
Using XRRay to request a hit test source
The XRSession.requestHitTestSource() method takes an XRRay object for its offsetRay option. In this example, the hit test source is positioned slightly above the viewer as the application has some UI elements at the bottom while wanting to maintain the perception of a centered cursor.
const xrSession = navigator.xr.requestSession("immersive-ar", {
requiredFeatures: ["local", "hit-test"],
});
let hitTestSource = null;
xrSession
.requestHitTestSource({
space: viewerSpace, // obtained from xrSession.requestReferenceSpace("viewer");
offsetRay: new XRRay({ y: 0.5 }),
})
.then((viewerHitTestSource) => {
hitTestSource = viewerHitTestSource;
});
Specifications
| Specification |
|---|
| WebXR Hit Test Module # xrray-interface |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
XRRay
|
|
|
|
|
|
|
|
|
|
|
|
|
XRRay() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
direction
|
|
|
|
|
|
|
|
|
|
|
|
|
matrix
|
|
|
|
|
|
|
|
|
|
|
|
|
origin
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.