XRInputSourceEventInit.inputSource

Secure context

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

The XRInputSourceEventInit dictionary's inputSource property is used when calling the XRInputSourceEvent() constructor to specify the XRInputSource from which the newly-created event is being sent.

Of course, as a general rule, you won't need to create XRInputSourceEventInit objects yourself. These events are generated by and sent to you by the WebXR infrastructure.

Syntax

let xrInputSourceEventInit.inputSource = xrInputSource;

let xrInputSourceEventInit = { inputSource: xrInputSource };

let xrInputSourceEvent = new XRInputSourceEvent(type, { inputSource: xrInputSource });

Value

An XRInputSource object indicating the source of the newly-created XRInputSourceEvent to be created. The new object's inputSource will be set to this value.

Examples

This example creates a new select event and sends it to the XRSession.

let event = new XRInputSourceEvent("select", {
  frame: eventFrame,
  inputSource: source
};
if (event) {
  xrSession.dispatchEvent(event);
}

Specifications

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