
<div class="tsd-page-title">
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
<li><a href="../modules/_babylonjs_core.html">@babylonjs/core</a></li>
<li><a href="" aria-current="page">KeyboardInfo</a></li></ul>
<h1>Class KeyboardInfo</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>This class is used to store keyboard related info for the onKeyboardObservable event.</p>
</div></section>
<section class="tsd-panel tsd-hierarchy" data-refl="49952">
<h4>Hierarchy (<a href="../hierarchy.html#@babylonjs/core.KeyboardInfo">View Summary</a>)</h4>
<ul class="tsd-hierarchy">
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">KeyboardInfo</span>
<ul class="tsd-hierarchy">
<li class="tsd-hierarchy-item"><a href="_babylonjs_core.KeyboardInfoPre.html" class="tsd-signature-type tsd-kind-class">KeyboardInfoPre</a></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon.js/blob/b248b370267f13bfaf5b2a0f8fd525bad7c99b52/packages/dev/core/src/Events/keyboardEvents.ts#L20">packages/dev/core/src/Events/keyboardEvents.ts:20</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-index-list"><a href="#event" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event</span></a>
<a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
</div></section></div></details></section></section>
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
<section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="">
<div class="tsd-signature tsd-anchor-link" id="constructorkeyboardinfo"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">KeyboardInfo</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_babylonjs_core.IKeyboardEvent.html" class="tsd-signature-type tsd-kind-interface">IKeyboardEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">KeyboardInfo</a><a href="#constructorkeyboardinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
<div class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Instantiates a new keyboard info.
This class is used to store keyboard related info for the onKeyboardObservable event.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">number</span></span>
<div class="tsd-comment tsd-typography"><p>Defines the type of event (KeyboardEventTypes)</p>
</div></li>
<li><span><span class="tsd-kind-parameter">event</span>: <a href="../interfaces/_babylonjs_core.IKeyboardEvent.html" class="tsd-signature-type tsd-kind-interface">IKeyboardEvent</a></span>
<div class="tsd-comment tsd-typography"><p>Defines the related dom event</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">KeyboardInfo</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon.js/blob/b248b370267f13bfaf5b2a0f8fd525bad7c99b52/packages/dev/core/src/Events/keyboardEvents.ts#L27">packages/dev/core/src/Events/keyboardEvents.ts:27</a></li></ul></aside></div></li></ul></section></section></details>
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
<section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="event"><span>event</span><a href="#event" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_babylonjs_core.IKeyboardEvent.html" class="tsd-signature-type tsd-kind-interface">IKeyboardEvent</a></div>
<div class="tsd-comment tsd-typography"><p>Defines the related dom event</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon.js/blob/b248b370267f13bfaf5b2a0f8fd525bad7c99b52/packages/dev/core/src/Events/keyboardEvents.ts#L35">packages/dev/core/src/Events/keyboardEvents.ts:35</a></li></ul></aside></section>
<section class="tsd-panel tsd-member">
<h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>Defines the type of event (KeyboardEventTypes)</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/BabylonJS/Babylon.js/blob/b248b370267f13bfaf5b2a0f8fd525bad7c99b52/packages/dev/core/src/Events/keyboardEvents.ts#L31">packages/dev/core/src/Events/keyboardEvents.ts:31</a></li></ul></aside></section></section></details>

Class KeyboardInfo

Hierarchy (View Summary)

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns KeyboardInfo

Properties

event

type