@illgrenoble/webx-client 0.9.0 → 1.0.0

package/dist/display/WebXWindow.d.ts

@@ -1,6 +1,12 @@
 import * as THREE from 'three';
 import { WebXTextureFactory } from './WebXTextureFactory';
 import { Texture } from 'three';
+/**
+ * Represents a window in the WebX display.
+ *
+ * This class manages the rendering of a single window, including its position,
+ * size, and texture updates.
+ */
 export declare class WebXWindow {
     static WINDOW_REFRESH_TIME_MS: number;
     private static _PLANE_GEOMETRY;
@@ -17,27 +23,138 @@ export declare class WebXWindow {
     private _width;
     private _height;
     private _windowRefreshTimeout;
+    /**
+     * Gets the THREE.js mesh representing the window.
+     *
+     * @returns The window mesh.
+     */
     get mesh(): THREE.Mesh;
+    /**
+     * Gets the color index of the window.
+     *
+     * @returns The color index as a number.
+     */
     get colorIndex(): number;
+    /**
+     * Gets the unique ID of the window.
+     *
+     * @returns The window ID as a number.
+     */
     get id(): number;
+    /**
+     * Gets the visibility status of the window.
+     *
+     * @returns True if the window is visible, false otherwise.
+     */
     get visible(): boolean;
+    /**
+     * Sets the visibility status of the window.
+     *
+     * @param visible True to make the window visible, false to hide it.
+     */
     private set visible(value);
+    /**
+     * Gets the color map texture of the window.
+     *
+     * @returns The color map as a Texture.
+     */
     get colorMap(): Texture;
+    /**
+     * Sets the color map texture of the window.
+     *
+     * @param colorMap The new color map as a Texture.
+     */
     private set colorMap(value);
+    /**
+     * Gets the alpha map texture of the window.
+     *
+     * @returns The alpha map as a Texture.
+     */
     get alphaMap(): Texture;
+    /**
+     * Sets the alpha map texture of the window.
+     *
+     * @param alphaMap The new alpha map as a Texture.
+     */
     private set alphaMap(value);
+    /**
+     * Checks if the color map is valid.
+     *
+     * @returns True if the color map is valid, false otherwise.
+     */
     get colorMapValid(): boolean;
+    /**
+     * Gets the depth of the window.
+     *
+     * @returns The depth as a number.
+     */
     get depth(): number;
+    /**
+     * Gets the x-coordinate of the window.
+     *
+     * @returns The x-coordinate as a number.
+     */
     get x(): number;
+    /**
+     * Sets the x-coordinate of the window.
+     *
+     * @param value The new x-coordinate as a number.
+     */
     set x(value: number);
+    /**
+     * Gets the y-coordinate of the window.
+     *
+     * @returns The y-coordinate as a number.
+     */
     get y(): number;
+    /**
+     * Sets the y-coordinate of the window.
+     *
+     * @param value The new y-coordinate as a number.
+     */
     set y(value: number);
+    /**
+     * Gets the z-index of the window.
+     *
+     * @returns The z-index as a number.
+     */
     get z(): number;
+    /**
+     * Sets the z-index of the window.
+     *
+     * @param value The new z-index as a number.
+     */
     set z(value: number);
+    /**
+     * Gets the width of the window.
+     *
+     * @returns The width as a number.
+     */
     get width(): number;
+    /**
+     * Sets the width of the window.
+     *
+     * @param value The new width as a number.
+     */
     set width(value: number);
+    /**
+     * Gets the height of the window.
+     *
+     * @returns The height as a number.
+     */
     get height(): number;
+    /**
+     * Sets the height of the window.
+     *
+     * @param value The new height as a number.
+     */
     set height(value: number);
+    /**
+     * Creates a new instance of WebXWindow.
+     *
+     * @param configuration The properties of the window, such as position and size.
+     * @param textureFactory The factory used to create textures for the window.
+     */
     constructor(configuration: {
         id: number;
         x: number;
@@ -46,12 +163,47 @@ export declare class WebXWindow {
         width: number;
         height: number;
     }, textureFactory: WebXTextureFactory);
+    /**
+     * Loads the window image from the texture factory.
+     */
     loadWindowImage(): Promise<void>;
+    /**
+     * Updates the position and size of the window.
+     *
+     * @param x The x-coordinate of the window.
+     * @param y The y-coordinate of the window.
+     * @param z The z-index of the window.
+     * @param width The width of the window.
+     * @param height The height of the window.
+     */
     setRectangle(x: number, y: number, z: number, width: number, height: number): void;
+    /**
+     * Updates the textures of the window with new image data.
+     *
+     * @param depth The depth of the image.
+     * @param colorMap The color texture.
+     * @param alphaMap The alpha texture.
+     * @param isFullWindow Whether to force an update of the textures.
+     */
     updateTexture(depth: number, colorMap: Texture, alphaMap: Texture, isFullWindow: boolean): void;
+    /**
+     * Updates the scale of the window mesh based on its width and height.
+     */
     private _updateScale;
+    /**
+     * Updates the position of the window mesh based on its x, y, and z coordinates.
+     */
     private _updatePosition;
+    /**
+     * Disposes of the resources used by the window.
+     */
     dispose(): void;
+    /**
+     * Disposes of the color map texture, releasing its resources.
+     */
     private _disposeColorMap;
+    /**
+     * Disposes of the alpha map texture, releasing its resources.
+     */
     private _disposeAlphaMap;
 }

package/dist/display/WebXWindow.js

@@ -12,79 +12,196 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXWindow = void 0;
 const THREE = require("three");
 const three_1 = require("three");
+/**
+ * Represents a window in the WebX display.
+ *
+ * This class manages the rendering of a single window, including its position,
+ * size, and texture updates.
+ */
 class WebXWindow {
+    /**
+     * Gets the THREE.js mesh representing the window.
+     *
+     * @returns The window mesh.
+     */
     get mesh() {
         return this._mesh;
     }
+    /**
+     * Gets the color index of the window.
+     *
+     * @returns The color index as a number.
+     */
     get colorIndex() {
         return this._colorIndex;
     }
+    /**
+     * Gets the unique ID of the window.
+     *
+     * @returns The window ID as a number.
+     */
     get id() {
         return this._id;
     }
+    /**
+     * Gets the visibility status of the window.
+     *
+     * @returns True if the window is visible, false otherwise.
+     */
     get visible() {
         return this._material.visible;
     }
+    /**
+     * Sets the visibility status of the window.
+     *
+     * @param visible True to make the window visible, false to hide it.
+     */
     set visible(visible) {
         if (this._material.visible !== visible) {
             this._material.visible = visible;
         }
     }
+    /**
+     * Gets the color map texture of the window.
+     *
+     * @returns The color map as a Texture.
+     */
     get colorMap() {
         return this._material.map;
     }
+    /**
+     * Sets the color map texture of the window.
+     *
+     * @param colorMap The new color map as a Texture.
+     */
     set colorMap(colorMap) {
         this._material.map = colorMap;
     }
+    /**
+     * Gets the alpha map texture of the window.
+     *
+     * @returns The alpha map as a Texture.
+     */
     get alphaMap() {
         return this._material.alphaMap;
     }
+    /**
+     * Sets the alpha map texture of the window.
+     *
+     * @param alphaMap The new alpha map as a Texture.
+     */
     set alphaMap(alphaMap) {
         this._material.alphaMap = alphaMap;
     }
+    /**
+     * Checks if the color map is valid.
+     *
+     * @returns True if the color map is valid, false otherwise.
+     */
     get colorMapValid() {
         return this.colorMap != null && this.colorMap.image.width === this._width && this.colorMap.image.height === this._height;
     }
+    /**
+     * Gets the depth of the window.
+     *
+     * @returns The depth as a number.
+     */
     get depth() {
         return this._depth;
     }
+    /**
+     * Gets the x-coordinate of the window.
+     *
+     * @returns The x-coordinate as a number.
+     */
     get x() {
         return this._x;
     }
+    /**
+     * Sets the x-coordinate of the window.
+     *
+     * @param value The new x-coordinate as a number.
+     */
     set x(value) {
         this._x = value;
         this._updatePosition();
     }
+    /**
+     * Gets the y-coordinate of the window.
+     *
+     * @returns The y-coordinate as a number.
+     */
     get y() {
         return this._y;
     }
+    /**
+     * Sets the y-coordinate of the window.
+     *
+     * @param value The new y-coordinate as a number.
+     */
     set y(value) {
         this._y = value;
         this._updatePosition();
     }
+    /**
+     * Gets the z-index of the window.
+     *
+     * @returns The z-index as a number.
+     */
     get z() {
         return this._z;
     }
+    /**
+     * Sets the z-index of the window.
+     *
+     * @param value The new z-index as a number.
+     */
     set z(value) {
         this._z = value;
         this._updatePosition();
     }
+    /**
+     * Gets the width of the window.
+     *
+     * @returns The width as a number.
+     */
     get width() {
         return this._width;
     }
+    /**
+     * Sets the width of the window.
+     *
+     * @param value The new width as a number.
+     */
     set width(value) {
         this._width = value;
         this._updateScale();
         this._updatePosition();
     }
+    /**
+     * Gets the height of the window.
+     *
+     * @returns The height as a number.
+     */
     get height() {
         return this._height;
     }
+    /**
+     * Sets the height of the window.
+     *
+     * @param value The new height as a number.
+     */
     set height(value) {
         this._height = value;
         this._updateScale();
         this._updatePosition();
     }
+    /**
+     * Creates a new instance of WebXWindow.
+     *
+     * @param configuration The properties of the window, such as position and size.
+     * @param textureFactory The factory used to create textures for the window.
+     */
     constructor(configuration, textureFactory) {
         this._width = 1;
         this._height = 1;
@@ -107,12 +224,24 @@ class WebXWindow {
         this._updateScale();
         this._updatePosition();
     }
+    /**
+     * Loads the window image from the texture factory.
+     */
     loadWindowImage() {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this._textureFactory.getWindowTexture(this._id);
             this.updateTexture(response.depth, response.colorMap, response.alphaMap, true);
         });
     }
+    /**
+     * Updates the position and size of the window.
+     *
+     * @param x The x-coordinate of the window.
+     * @param y The y-coordinate of the window.
+     * @param z The z-index of the window.
+     * @param width The width of the window.
+     * @param height The height of the window.
+     */
     setRectangle(x, y, z, width, height) {
         this._x = x;
         this._y = y;
@@ -132,6 +261,14 @@ class WebXWindow {
         this._updateScale();
         this._updatePosition();
     }
+    /**
+     * Updates the textures of the window with new image data.
+     *
+     * @param depth The depth of the image.
+     * @param colorMap The color texture.
+     * @param alphaMap The alpha texture.
+     * @param isFullWindow Whether to force an update of the textures.
+     */
     updateTexture(depth, colorMap, alphaMap, isFullWindow) {
         this._depth = depth;
         // Dispose of previous texture
@@ -171,12 +308,21 @@ class WebXWindow {
             }, WebXWindow.WINDOW_REFRESH_TIME_MS);
         }
     }
+    /**
+     * Updates the scale of the window mesh based on its width and height.
+     */
     _updateScale() {
         this._mesh.scale.set(this._width, this._height, 1);
     }
+    /**
+     * Updates the position of the window mesh based on its x, y, and z coordinates.
+     */
     _updatePosition() {
         this._mesh.position.set(this._x + 0.5 * this._width, this._y + 0.5 * this._height, this._z);
     }
+    /**
+     * Disposes of the resources used by the window.
+     */
     dispose() {
         this._disposeColorMap();
         this._disposeAlphaMap();
@@ -186,12 +332,18 @@ class WebXWindow {
             this._windowRefreshTimeout = null;
         }
     }
+    /**
+     * Disposes of the color map texture, releasing its resources.
+     */
     _disposeColorMap() {
         if (this.colorMap) {
             this.colorMap.dispose();
             this.colorMap = null;
         }
     }
+    /**
+     * Disposes of the alpha map texture, releasing its resources.
+     */
     _disposeAlphaMap() {
         if (this.alphaMap) {
             this.alphaMap.dispose();

package/dist/display/WebXWindow.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXWindow.js","sourceRoot":"","sources":["../../src/display/WebXWindow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+BAA+B;AAE/B,iCAA8C;AAE9C,MAAa,UAAU;IAoBrB,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,IAAY,OAAO,CAAC,OAAgB;QAClC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACvC,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;QACnC,CAAC;IACH,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;IAC5B,CAAC;IAED,IAAY,QAAQ,CAAC,QAAiB;QACpC,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC;IAChC,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;IACjC,CAAC;IAED,IAAY,QAAQ,CAAC,QAAiB;QACpC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACrC,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC;IAC3H,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAa;QAC5B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAW,MAAM,CAAC,KAAa;QAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED,YAAY,aAA6F,EAAE,cAAkC;QAlGrI,WAAM,GAAW,CAAC,CAAC;QACnB,YAAO,GAAW,CAAC,CAAC;QAEpB,0BAAqB,GAAW,IAAI,CAAC;QAgG3C,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,YAAY,EAAE,CAAC;QAE7C,kHAAkH;QAClH,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;QAErC,+CAA+C;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QAErB,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;QACrD,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAExE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAEY,eAAe;;YAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACjF,CAAC;KAAA;IAEM,YAAY,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS,EAAE,KAAa,EAAE,MAAc;QAChF,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAE7G,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC/G,CAAC;YAED,6CAA6C;YAC7C,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC7F,IAAI,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,CAAC;YAChC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAEM,aAAa,CAAC,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,YAAqB;QAC7F,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QAEpB,8BAA8B;QAC9B,IAAI,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC3B,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,SAAS,GAAG,oBAAY,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC7G,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;QACpC,CAAC;QAED,wCAAwC;QACxC,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC9B,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC3B,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAY,CAAC;YACvC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC7G,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;QAEpC,CAAC;aAAM,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;YACvB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC;QAErE,oDAAoD;QACpD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;gBACzC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;YACpC,CAAC;YACD,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;gBAClD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,CAAC;YAChC,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,OAAO;QACL,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACzC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACpC,CAAC;IACH,CAAC;IAEO,gBAAgB;QACtB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;IACH,CAAC;IAEO,gBAAgB;QACtB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;IACH,CAAC;;AAjPH,gCAkPC;AAjPe,iCAAsB,GAAG,IAAI,AAAP,CAAQ;AAC7B,0BAAe,GAAwB,IAAI,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,AAA/D,CAAgE;AAC/E,uBAAY,GAAG,CAAC,AAAJ,CAAK"}
+{"version":3,"file":"WebXWindow.js","sourceRoot":"","sources":["../../src/display/WebXWindow.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+BAA+B;AAE/B,iCAA8C;AAE9C;;;;;GAKG;AACH,MAAa,UAAU;IAoBrB;;;;OAIG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAY,OAAO,CAAC,OAAgB;QAClC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YACvC,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAY,QAAQ,CAAC,QAAiB;QACpC,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,QAAQ,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAY,QAAQ,CAAC,QAAiB;QACpC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC;IAC3H,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAW,CAAC,CAAC,KAAa;QACxB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC;QAChB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAW,KAAK,CAAC,KAAa;QAC5B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAW,MAAM,CAAC,KAAa;QAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,YAAY,aAA6F,EAAE,cAAkC;QAjNrI,WAAM,GAAW,CAAC,CAAC;QACnB,YAAO,GAAW,CAAC,CAAC;QAEpB,0BAAqB,GAAW,IAAI,CAAC;QA+M3C,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,YAAY,EAAE,CAAC;QAE7C,kHAAkH;QAClH,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;QAErC,+CAA+C;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QAErB,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;QACrD,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAExE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACU,eAAe;;YAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACjF,CAAC;KAAA;IAED;;;;;;;;OAQG;IACI,YAAY,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS,EAAE,KAAa,EAAE,MAAc;QAChF,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAE7G,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC/G,CAAC;YAED,6CAA6C;YAC7C,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC7F,IAAI,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,CAAC;YAChC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAAC,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,YAAqB;QAC7F,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QAEpB,8BAA8B;QAC9B,IAAI,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC3B,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,SAAS,GAAG,oBAAY,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC7G,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;QACpC,CAAC;QAED,wCAAwC;QACxC,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC9B,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC3B,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,oBAAY,CAAC;YACvC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC7G,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;QAEpC,CAAC;aAAM,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;YACvB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC;QAErE,oDAAoD;QACpD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC/B,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;gBACzC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;YACpC,CAAC;YACD,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;gBAClD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;gBAClC,IAAI,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,CAAC;YAChC,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED;;OAEG;IACK,YAAY;QAClB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACK,eAAe;QACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACzC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;IACH,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;IACH,CAAC;;AAnYH,gCAoYC;AAnYe,iCAAsB,GAAG,IAAI,AAAP,CAAQ;AAC7B,0BAAe,GAAwB,IAAI,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,AAA/D,CAAgE;AAC/E,uBAAY,GAAG,CAAC,AAAJ,CAAK"}

package/dist/display/WebXWindowProperties.d.ts

@@ -1,10 +1,35 @@
+/**
+ * Represents the properties of a WebX window.
+ *
+ * These properties define the position, size, and ID of a window in the WebX display.
+ */
 export declare class WebXWindowProperties {
-    id: number;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    constructor(configuration: {
+    /**
+     * The unique identifier of the window.
+     */
+    readonly id: number;
+    /**
+     * The x-coordinate of the window.
+     */
+    readonly x: number;
+    /**
+     * The y-coordinate of the window.
+     */
+    readonly y: number;
+    /**
+     * The width of the window.
+     */
+    readonly width: number;
+    /**
+     * The height of the window.
+     */
+    readonly height: number;
+    /**
+     * Creates a new instance of WebXWindowProperties.
+     *
+     * @param properties The properties of the window, including position, size, and ID.
+     */
+    constructor(properties: {
         id: number;
         x: number;
         y: number;

package/dist/display/WebXWindowProperties.js

@@ -1,16 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebXWindowProperties = void 0;
+/**
+ * Represents the properties of a WebX window.
+ *
+ * These properties define the position, size, and ID of a window in the WebX display.
+ */
 class WebXWindowProperties {
-    constructor(configuration) {
-        this.width = 1;
-        this.height = 1;
-        const { id, x, y, width, height } = configuration;
-        this.id = id;
-        this.x = x;
-        this.y = y;
-        this.width = width;
-        this.height = height;
+    /**
+     * Creates a new instance of WebXWindowProperties.
+     *
+     * @param properties The properties of the window, including position, size, and ID.
+     */
+    constructor(properties) {
+        this.id = properties.id;
+        this.x = properties.x;
+        this.y = properties.y;
+        this.width = properties.width;
+        this.height = properties.height;
     }
 }
 exports.WebXWindowProperties = WebXWindowProperties;

package/dist/display/WebXWindowProperties.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebXWindowProperties.js","sourceRoot":"","sources":["../../src/display/WebXWindowProperties.ts"],"names":[],"mappings":";;;AAAA,MAAa,oBAAoB;IAO/B,YAAY,aAAkF;QAHvF,UAAK,GAAW,CAAC,CAAC;QAClB,WAAM,GAAW,CAAC,CAAC;QAGxB,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;QAClD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAfD,oDAeC"}
+{"version":3,"file":"WebXWindowProperties.js","sourceRoot":"","sources":["../../src/display/WebXWindowProperties.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,oBAAoB;IA0B/B;;;;OAIG;IACH,YAAY,UAA+E;QACzF,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;IAClC,CAAC;CACF;AAtCD,oDAsCC"}

package/dist/input/WebXKeyboard.d.ts

@@ -1,4 +1,10 @@
 import { WebXKeyboardModifierState } from './keyboard';
+/**
+ * Represents the keyboard input device in the WebX client.
+ *
+ * This class handles keyboard events, such as key presses and releases,
+ * and provides methods to interact with the keyboard state.
+ */
 export declare class WebXKeyboard {
     private static _NEXT_ID;
     /**
@@ -76,23 +82,50 @@ export declare class WebXKeyboard {
         [index: number]: boolean;
     };
     /**
-     * Create a new keyboard instance
-     * @param element the element to bind the keyboard to
+     * Constructs a new WebXKeyboard instance.
+     *
+     * @param element The HTML element to attach the keyboard events to.
      */
     constructor(element: HTMLElement | Document);
+    /**
+     * Disposes of the keyboard instance and removes event listeners.
+     */
     dispose(): void;
     /**
      * Set quirk flags depending on platform/browser, if such information is available
      */
     private _handleQuirks;
+    /**
+     * Adds a keyboard event to the internal event queue.
+     *
+     * @param event The keyboard event to add.
+     */
     private _addEvent;
     /**
      * Bind the keyboard listeners to the given element
      */
     private _bindListeners;
+    /**
+     * Unbinds the keyboard listeners from the associated element.
+     */
     private _unbindListeners;
+    /**
+     * Handles the keydown event by interpreting and processing it.
+     *
+     * @param event The keyboard event to handle.
+     */
     private _bindKeyDownListener;
+    /**
+     * Handles the keypress event by interpreting and processing it.
+     *
+     * @param event The keyboard event to handle.
+     */
     private _bindKeyPressListener;
+    /**
+     * Handles the keyup event by interpreting and processing it.
+     *
+     * @param event The keyboard event to handle.
+     */
     private _bindKeyUpListener;
     /**
      * Returns the keyboard location of the key associated with the given
@@ -183,12 +216,14 @@ export declare class WebXKeyboard {
      */
     private _handleKeyDown;
     /**
-     * Clear the key repeat timers
+     * Clears the timers used for key repeat functionality.
      */
     private _clearKeyRepeatTimers;
     /**
-     * Checks to see if a key is pressed
-     * @param keysym the key to check
+     * Checks if a key is currently pressed.
+     *
+     * @param keysym The keysym of the key to check.
+     * @returns true if the key is pressed, false otherwise.
      */
     private _isKeyPressed;
     /**