XRSession.onsqueezestart

Secure context

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The XRSession interface's onsqueezestart event handler property can be set to a function which is then invoked to handle the squeezestart event that's sent when the user successfully begins a primary squeeze action on a WebXR input device. These actions represent the user squeezing or tightly gripping an object or controller.

To learn more about how to use and handle WebXR controller inputs, see Inputs and input sources.

Syntax

xrSession.onsqueezestart = squeezestartHandlerFunction;

Value

A function to be invoked whenever the XRSession receives a squeezestart event.

Examples

This snippet of code adds a simple handler for the squeezestart event, which responds only to events on the user's dominant hand by getting the target ray, then calling a function findObjectUsingRay() to identify the object that the user is pointing at. This object is then stored in a heldObject variable in the user object we're using to represent user information.

xrSession.onsqueezestart = event => {
  if (event.inputSource.handedness == user.handedness) {
    let targetRayPose = event.frame.getPose(event.inputSource.targetRaySpace, myRefSpace;

    if (targetRayPose) {
      user.heldObject = findObjectUsingRay(targetRayPose.transform);
    }
  }
};

Specifications

Specification Status Comment
WebXR Device API
The definition of 'XRSession.onsqueezestart' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also