<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>XRInputSourceEvent | Babylon.js API documentation</title><meta name="description" content="Documentation for Babylon.js API documentation"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Babylon.js API documentation</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">Babylon.js API documentation</a></li><li><a href="XRInputSourceEvent.html">XRInputSourceEvent</a></li></ul><h1>Class XRInputSourceEvent </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>XRInputSourceEvents are fired to indicate changes to the state of an XRInputSource.
ref: <a href="https://immersive-web.github.io/webxr/#xrinputsourceevent-interface">https://immersive-web.github.io/webxr/#xrinputsourceevent-interface</a></p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Event</span><ul class="tsd-hierarchy"><li><span class="target">XRInputSourceEvent</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="XRInputSourceEvent.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="XRInputSourceEvent.html#frame" class="tsd-kind-icon">frame</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="XRInputSourceEvent.html#inputSource" class="tsd-kind-icon">input<wbr>Source</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="XRInputSourceEvent.html#type" class="tsd-kind-icon">type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new XRInput<wbr>Source<wbr>Event<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../index.html#XRInputSourceEventType" class="tsd-signature-type" data-tsd-kind="Type alias">XRInputSourceEventType</a>, eventInitDict<span class="tsd-signature-symbol">?: </span><a href="../interfaces/XRInputSourceEventInit.html" class="tsd-signature-type" data-tsd-kind="Interface">XRInputSourceEventInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="XRInputSourceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">XRInputSourceEvent</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Event.constructor</p><ul><li>Defined in .temp/docdirectory/doc.d.ts:114764</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <a href="../index.html#XRInputSourceEventType" class="tsd-signature-type" data-tsd-kind="Type alias">XRInputSourceEventType</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> eventInitDict: <a href="../interfaces/XRInputSourceEventInit.html" class="tsd-signature-type" data-tsd-kind="Interface">XRInputSourceEventInit</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="XRInputSourceEvent.html" class="tsd-signature-type" data-tsd-kind="Class">XRInputSourceEvent</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="frame" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> frame<a href="#frame" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">frame<span class="tsd-signature-symbol">:</span> <a href="XRFrame.html" class="tsd-signature-type" data-tsd-kind="Class">XRFrame</a></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:114761</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="inputSource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> input<wbr>Source<a href="#inputSource" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">input<wbr>Source<span class="tsd-signature-symbol">:</span> <a href="XRInputSource.html" class="tsd-signature-type" data-tsd-kind="Class">XRInputSource</a></div><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:114762</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../index.html#XRInputSourceEventType" class="tsd-signature-type" data-tsd-kind="Type alias">XRInputSourceEventType</a></div><aside class="tsd-sources"><p>Overrides Event.type</p><ul><li>Defined in .temp/docdirectory/doc.d.ts:114760</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/BABYLON.html">BABYLON</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="XRInputSourceEvent.html" class="tsd-kind-icon">XRInput<wbr>Source<wbr>Event</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="XRInputSourceEvent.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="XRInputSourceEvent.html#frame" class="tsd-kind-icon">frame</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="XRInputSourceEvent.html#inputSource" class="tsd-kind-icon">input<wbr>Source</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="XRInputSourceEvent.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div></body></html>

Class XRInputSourceEvent

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

type: XRInputSourceEventType

Optional eventInitDict: XRInputSourceEventInit

Returns XRInputSourceEvent

Properties

Readonly frame Search playground for frame

Readonly inputSource Search playground for inputSource

Readonly type Search playground for type

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

type: XRInputSourceEventType

Optional eventInitDict: XRInputSourceEventInit

Returns XRInputSourceEvent

Properties

Readonly frameSearch playground for frame

Readonly inputSourceSearch playground for inputSource

Readonly typeSearch playground for type

Readonly frame Search playground for frame

Readonly inputSource Search playground for inputSource

Readonly type Search playground for type