@itwin/core-common 3.5.0-dev.5 → 3.5.0-dev.52

package/lib/cjs/IModelVersion.js

@@ -1,80 +1,80 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module iModels
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IModelVersion = void 0;
-/** Option to specify the version of the iModel to be acquired and used
- * @public
- */
-class IModelVersion {
-    constructor() { }
-    /** Describes the first version of the iModel */
-    static first() {
-        const version = new IModelVersion();
-        version._first = true;
-        return version;
-    }
-    /** Describes the latest version of the iModel  */
-    static latest() {
-        const version = new IModelVersion();
-        version._latest = true;
-        return version;
-    }
-    /** Describes a version of the iModel by the last change set that needs
-     * to be applied or merged to the iModel.
-     * Note that all ChangeSets up to and and including the specified ChangeSet
-     * needs to be applied.
-     * If the changesetId is an empty string, it is assumed to be the first version
-     * before any change sets have been applied.
-     */
-    static asOfChangeSet(changesetId) {
-        const version = new IModelVersion();
-        if (changesetId === "") {
-            version._first = true;
-            return version;
-        }
-        version._afterChangeSetId = changesetId;
-        return version;
-    }
-    /** Describes a version of the iModel with the specified version name  */
-    static named(versionName) {
-        const version = new IModelVersion();
-        version._versionName = versionName;
-        return version;
-    }
-    toJSON() {
-        return this._versionName ? { versionName: this._versionName } :
-            this._afterChangeSetId ? { afterChangeSetId: this._afterChangeSetId } :
-                this._first ? { first: this._first } :
-                    { latest: true };
-    }
-    /** Creates a version from an IModelVersionProps */
-    static fromJSON(json) {
-        const version = new IModelVersion();
-        version._first = json.first;
-        version._afterChangeSetId = json.afterChangeSetId;
-        version._latest = json.latest;
-        version._versionName = json.versionName;
-        return version;
-    }
-    /** Returns true if this describes the first version */
-    get isFirst() { return !!this._first; }
-    /** Returns true if this describes the latest version */
-    get isLatest() { return !!this._latest; }
-    /** Returns the last change set id to be applied to the iModel
-     * to get to this specified version. @see asOfChangeSet().
-     * Note that this method does not attempt to resolve the change set
-     * if this describes the first version, last version, named version, etc.
-     * @see evaluateChangeSet() for those use cases.
-     */
-    getAsOfChangeSet() { return this._afterChangeSetId; }
-    /** Returns the name of the version if this describes a named version. @see named() */
-    getName() { return this._versionName; }
-}
-exports.IModelVersion = IModelVersion;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IModelVersion = void 0;
+/** Option to specify the version of the iModel to be acquired and used
+ * @public
+ */
+class IModelVersion {
+    constructor() { }
+    /** Describes the first version of the iModel */
+    static first() {
+        const version = new IModelVersion();
+        version._first = true;
+        return version;
+    }
+    /** Describes the latest version of the iModel  */
+    static latest() {
+        const version = new IModelVersion();
+        version._latest = true;
+        return version;
+    }
+    /** Describes a version of the iModel by the last change set that needs
+     * to be applied or merged to the iModel.
+     * Note that all ChangeSets up to and and including the specified ChangeSet
+     * needs to be applied.
+     * If the changesetId is an empty string, it is assumed to be the first version
+     * before any change sets have been applied.
+     */
+    static asOfChangeSet(changesetId) {
+        const version = new IModelVersion();
+        if (changesetId === "") {
+            version._first = true;
+            return version;
+        }
+        version._afterChangeSetId = changesetId;
+        return version;
+    }
+    /** Describes a version of the iModel with the specified version name  */
+    static named(versionName) {
+        const version = new IModelVersion();
+        version._versionName = versionName;
+        return version;
+    }
+    toJSON() {
+        return this._versionName ? { versionName: this._versionName } :
+            this._afterChangeSetId ? { afterChangeSetId: this._afterChangeSetId } :
+                this._first ? { first: this._first } :
+                    { latest: true };
+    }
+    /** Creates a version from an IModelVersionProps */
+    static fromJSON(json) {
+        const version = new IModelVersion();
+        version._first = json.first;
+        version._afterChangeSetId = json.afterChangeSetId;
+        version._latest = json.latest;
+        version._versionName = json.versionName;
+        return version;
+    }
+    /** Returns true if this describes the first version */
+    get isFirst() { return !!this._first; }
+    /** Returns true if this describes the latest version */
+    get isLatest() { return !!this._latest; }
+    /** Returns the last change set id to be applied to the iModel
+     * to get to this specified version. @see asOfChangeSet().
+     * Note that this method does not attempt to resolve the change set
+     * if this describes the first version, last version, named version, etc.
+     * @see evaluateChangeSet() for those use cases.
+     */
+    getAsOfChangeSet() { return this._afterChangeSetId; }
+    /** Returns the name of the version if this describes a named version. @see named() */
+    getName() { return this._versionName; }
+}
+exports.IModelVersion = IModelVersion;
 //# sourceMappingURL=IModelVersion.js.map

package/lib/cjs/IModelVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelVersion.js","sourceRoot":"","sources":["../../src/IModelVersion.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAaH;;GAEG;AACH,MAAa,aAAa;IAMxB,gBAAwB,CAAC;IAEzB,gDAAgD;IACzC,MAAM,CAAC,KAAK;QACjB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kDAAkD;IAC3C,MAAM,CAAC,MAAM;QAClB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,WAAmB;QAC7C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QAEpC,IAAI,WAAW,KAAK,EAAE,EAAE;YACtB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;YACtB,OAAO,OAAO,CAAC;SAChB;QAED,OAAO,CAAC,iBAAiB,GAAG,WAAW,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,KAAK,CAAC,WAAmB;QACrC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,YAAY,GAAG,WAAW,CAAC;QACnC,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACrE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;oBACpC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAwB;QAC7C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uDAAuD;IACvD,IAAW,OAAO,KAAc,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvD,wDAAwD;IACxD,IAAW,QAAQ,KAAc,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzD;;;;;OAKG;IACI,gBAAgB,KAA8B,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAErF,sFAAsF;IAC/E,OAAO,KAAyB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;CACnE;AAjFD,sCAiFC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { ChangesetId } from \"./ChangesetProps\";\n\n/** Properties for IModelVersion\n * @public\n */\nexport type IModelVersionProps =\n  { first: true, latest?: never, afterChangeSetId?: never, versionName?: never } |\n  { latest: true, first?: never, afterChangeSetId?: never, versionName?: never } |\n  { afterChangeSetId: string, first?: never, latest?: never, versionName?: never } |\n  { versionName: string, first?: never, latest?: never, afterChangeSetId?: never };\n\n/** Option to specify the version of the iModel to be acquired and used\n * @public\n */\nexport class IModelVersion {\n  private _first?: boolean;\n  private _latest?: boolean;\n  private _afterChangeSetId?: string;\n  private _versionName?: string;\n\n  private constructor() { }\n\n  /** Describes the first version of the iModel */\n  public static first(): IModelVersion {\n    const version = new IModelVersion();\n    version._first = true;\n    return version;\n  }\n\n  /** Describes the latest version of the iModel  */\n  public static latest(): IModelVersion {\n    const version = new IModelVersion();\n    version._latest = true;\n    return version;\n  }\n\n  /** Describes a version of the iModel by the last change set that needs\n   * to be applied or merged to the iModel.\n   * Note that all ChangeSets up to and and including the specified ChangeSet\n   * needs to be applied.\n   * If the changesetId is an empty string, it is assumed to be the first version\n   * before any change sets have been applied.\n   */\n  public static asOfChangeSet(changesetId: string): IModelVersion {\n    const version = new IModelVersion();\n\n    if (changesetId === \"\") {\n      version._first = true;\n      return version;\n    }\n\n    version._afterChangeSetId = changesetId;\n    return version;\n  }\n\n  /** Describes a version of the iModel with the specified version name  */\n  public static named(versionName: string): IModelVersion {\n    const version = new IModelVersion();\n    version._versionName = versionName;\n    return version;\n  }\n\n  public toJSON(): IModelVersionProps {\n    return this._versionName ? { versionName: this._versionName } :\n      this._afterChangeSetId ? { afterChangeSetId: this._afterChangeSetId } :\n        this._first ? { first: this._first } :\n          { latest: true };\n  }\n\n  /** Creates a version from an IModelVersionProps */\n  public static fromJSON(json: IModelVersionProps): IModelVersion {\n    const version = new IModelVersion();\n    version._first = json.first;\n    version._afterChangeSetId = json.afterChangeSetId;\n    version._latest = json.latest;\n    version._versionName = json.versionName;\n    return version;\n  }\n\n  /** Returns true if this describes the first version */\n  public get isFirst(): boolean { return !!this._first; }\n\n  /** Returns true if this describes the latest version */\n  public get isLatest(): boolean { return !!this._latest; }\n\n  /** Returns the last change set id to be applied to the iModel\n   * to get to this specified version. @see asOfChangeSet().\n   * Note that this method does not attempt to resolve the change set\n   * if this describes the first version, last version, named version, etc.\n   * @see evaluateChangeSet() for those use cases.\n   */\n  public getAsOfChangeSet(): ChangesetId | undefined { return this._afterChangeSetId; }\n\n  /** Returns the name of the version if this describes a named version. @see named() */\n  public getName(): string | undefined { return this._versionName; }\n}\n"]}
+{"version":3,"file":"IModelVersion.js","sourceRoot":"","sources":["../../src/IModelVersion.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAaH;;GAEG;AACH,MAAa,aAAa;IAMxB,gBAAwB,CAAC;IAEzB,gDAAgD;IACzC,MAAM,CAAC,KAAK;QACjB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kDAAkD;IAC3C,MAAM,CAAC,MAAM;QAClB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,WAAmB;QAC7C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QAEpC,IAAI,WAAW,KAAK,EAAE,EAAE;YACtB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;YACtB,OAAO,OAAO,CAAC;SAChB;QAED,OAAO,CAAC,iBAAiB,GAAG,WAAW,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,KAAK,CAAC,WAAmB;QACrC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,YAAY,GAAG,WAAW,CAAC;QACnC,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACrE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;oBACpC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,QAAQ,CAAC,IAAwB;QAC7C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;QACxC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uDAAuD;IACvD,IAAW,OAAO,KAAc,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvD,wDAAwD;IACxD,IAAW,QAAQ,KAAc,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzD;;;;;OAKG;IACI,gBAAgB,KAA8B,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAErF,sFAAsF;IAC/E,OAAO,KAAyB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;CACnE;AAjFD,sCAiFC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { ChangesetId } from \"./ChangesetProps\";\r\n\r\n/** Properties for IModelVersion\r\n * @public\r\n */\r\nexport type IModelVersionProps =\r\n  { first: true, latest?: never, afterChangeSetId?: never, versionName?: never } |\r\n  { latest: true, first?: never, afterChangeSetId?: never, versionName?: never } |\r\n  { afterChangeSetId: string, first?: never, latest?: never, versionName?: never } |\r\n  { versionName: string, first?: never, latest?: never, afterChangeSetId?: never };\r\n\r\n/** Option to specify the version of the iModel to be acquired and used\r\n * @public\r\n */\r\nexport class IModelVersion {\r\n  private _first?: boolean;\r\n  private _latest?: boolean;\r\n  private _afterChangeSetId?: string;\r\n  private _versionName?: string;\r\n\r\n  private constructor() { }\r\n\r\n  /** Describes the first version of the iModel */\r\n  public static first(): IModelVersion {\r\n    const version = new IModelVersion();\r\n    version._first = true;\r\n    return version;\r\n  }\r\n\r\n  /** Describes the latest version of the iModel  */\r\n  public static latest(): IModelVersion {\r\n    const version = new IModelVersion();\r\n    version._latest = true;\r\n    return version;\r\n  }\r\n\r\n  /** Describes a version of the iModel by the last change set that needs\r\n   * to be applied or merged to the iModel.\r\n   * Note that all ChangeSets up to and and including the specified ChangeSet\r\n   * needs to be applied.\r\n   * If the changesetId is an empty string, it is assumed to be the first version\r\n   * before any change sets have been applied.\r\n   */\r\n  public static asOfChangeSet(changesetId: string): IModelVersion {\r\n    const version = new IModelVersion();\r\n\r\n    if (changesetId === \"\") {\r\n      version._first = true;\r\n      return version;\r\n    }\r\n\r\n    version._afterChangeSetId = changesetId;\r\n    return version;\r\n  }\r\n\r\n  /** Describes a version of the iModel with the specified version name  */\r\n  public static named(versionName: string): IModelVersion {\r\n    const version = new IModelVersion();\r\n    version._versionName = versionName;\r\n    return version;\r\n  }\r\n\r\n  public toJSON(): IModelVersionProps {\r\n    return this._versionName ? { versionName: this._versionName } :\r\n      this._afterChangeSetId ? { afterChangeSetId: this._afterChangeSetId } :\r\n        this._first ? { first: this._first } :\r\n          { latest: true };\r\n  }\r\n\r\n  /** Creates a version from an IModelVersionProps */\r\n  public static fromJSON(json: IModelVersionProps): IModelVersion {\r\n    const version = new IModelVersion();\r\n    version._first = json.first;\r\n    version._afterChangeSetId = json.afterChangeSetId;\r\n    version._latest = json.latest;\r\n    version._versionName = json.versionName;\r\n    return version;\r\n  }\r\n\r\n  /** Returns true if this describes the first version */\r\n  public get isFirst(): boolean { return !!this._first; }\r\n\r\n  /** Returns true if this describes the latest version */\r\n  public get isLatest(): boolean { return !!this._latest; }\r\n\r\n  /** Returns the last change set id to be applied to the iModel\r\n   * to get to this specified version. @see asOfChangeSet().\r\n   * Note that this method does not attempt to resolve the change set\r\n   * if this describes the first version, last version, named version, etc.\r\n   * @see evaluateChangeSet() for those use cases.\r\n   */\r\n  public getAsOfChangeSet(): ChangesetId | undefined { return this._afterChangeSetId; }\r\n\r\n  /** Returns the name of the version if this describes a named version. @see named() */\r\n  public getName(): string | undefined { return this._versionName; }\r\n}\r\n"]}

package/lib/cjs/Image.d.ts

@@ -1,87 +1,87 @@
-/** @packageDocumentation
- * @module Rendering
- */
-/** Format of an [[ImageBuffer]].
- * The format determines how many bytes are allocated for each pixel in the buffer and the semantics of each byte.
- * @see [[ImageBuffer.getNumBytesPerPixel]]
- * @public
- * @extensions
- */
-export declare enum ImageBufferFormat {
-    /** RGBA format - 4 bytes per pixel. */
-    Rgba = 0,
-    /** RGB format - 3 bytes per pixel. */
-    Rgb = 2,
-    /** 1 byte per pixel. */
-    Alpha = 5
-}
-/** Uncompressed rectangular bitmap image data.
- * @public
- */
-export declare class ImageBuffer {
-    /** Image data in which each pixel occupies 1 or more bytes depending of the [[ImageBufferFormat]]. */
-    readonly data: Uint8Array;
-    /** Format of the bytes in the image. */
-    readonly format: ImageBufferFormat;
-    /** Width of image in pixels */
-    readonly width: number;
-    /** Return the number of bytes allocated for each pixel. */
-    get numBytesPerPixel(): number;
-    /** Determine the number of bytes allocated to a single pixel for the specified format. */
-    static getNumBytesPerPixel(format: ImageBufferFormat): number;
-    /** Get the height of this image in pixels. */
-    get height(): number;
-    /** Create a new ImageBuffer.
-     * @note The ImageBuffer takes ownership of the input Uint8Array.
-     * @param data The uncompressed image bytes. Must be a multiple of the width times the number of bytes per pixel specified by the format.
-     * @param format The format of the image.
-     * @param width The width of the image in pixels.
-     * @returns A new ImageBuffer.
-     * @throws Error if the length of the Uint8Array is not appropriate for the specified width and format.
-     */
-    static create(data: Uint8Array, format: ImageBufferFormat, width: number): ImageBuffer;
-    /** @internal */
-    protected static isValidData(data: Uint8Array, format: ImageBufferFormat, width: number): boolean;
-    /** @internal */
-    protected static computeHeight(data: Uint8Array, format: ImageBufferFormat, width: number): number;
-    /** @internal */
-    protected constructor(data: Uint8Array, format: ImageBufferFormat, width: number);
-}
-/** Returns whether the input is a power of two.
- * @note Floating point inputs are truncated.
- * @public
- */
-export declare function isPowerOfTwo(num: number): boolean;
-/** Returns the first power-of-two value greater than or equal to the input.
- * @note Floating point inputs are truncated.
- * @public
- */
-export declare function nextHighestPowerOfTwo(num: number): number;
-/** The format of an ImageSource.
- * @public
- * @extensions
- */
-export declare enum ImageSourceFormat {
-    /** Image data is stored with JPEG compression. */
-    Jpeg = 0,
-    /** Image data is stored with PNG compression. */
-    Png = 2,
-    /** Image is stored as an Svg stream.
-     * @note SVG is only valid for ImageSources in JavaScript. It *may not* be used for persistent textures.
-     */
-    Svg = 3
-}
-/** @internal */
-export declare function isValidImageSourceFormat(format: ImageSourceFormat): boolean;
-/** Image data encoded and compressed in either Jpeg or Png format.
- * @public
- */
-export declare class ImageSource {
-    /** The content of the image, compressed */
-    readonly data: Uint8Array | string;
-    /** The compression type. */
-    readonly format: ImageSourceFormat;
-    /** Construct a new ImageSource, which takes ownership of the Uint8Array. */
-    constructor(data: Uint8Array | string, format: ImageSourceFormat);
-}
+/** @packageDocumentation
+ * @module Rendering
+ */
+/** Format of an [[ImageBuffer]].
+ * The format determines how many bytes are allocated for each pixel in the buffer and the semantics of each byte.
+ * @see [[ImageBuffer.getNumBytesPerPixel]]
+ * @public
+ * @extensions
+ */
+export declare enum ImageBufferFormat {
+    /** RGBA format - 4 bytes per pixel. */
+    Rgba = 0,
+    /** RGB format - 3 bytes per pixel. */
+    Rgb = 2,
+    /** 1 byte per pixel. */
+    Alpha = 5
+}
+/** Uncompressed rectangular bitmap image data.
+ * @public
+ */
+export declare class ImageBuffer {
+    /** Image data in which each pixel occupies 1 or more bytes depending of the [[ImageBufferFormat]]. */
+    readonly data: Uint8Array;
+    /** Format of the bytes in the image. */
+    readonly format: ImageBufferFormat;
+    /** Width of image in pixels */
+    readonly width: number;
+    /** Return the number of bytes allocated for each pixel. */
+    get numBytesPerPixel(): number;
+    /** Determine the number of bytes allocated to a single pixel for the specified format. */
+    static getNumBytesPerPixel(format: ImageBufferFormat): number;
+    /** Get the height of this image in pixels. */
+    get height(): number;
+    /** Create a new ImageBuffer.
+     * @note The ImageBuffer takes ownership of the input Uint8Array.
+     * @param data The uncompressed image bytes. Must be a multiple of the width times the number of bytes per pixel specified by the format.
+     * @param format The format of the image.
+     * @param width The width of the image in pixels.
+     * @returns A new ImageBuffer.
+     * @throws Error if the length of the Uint8Array is not appropriate for the specified width and format.
+     */
+    static create(data: Uint8Array, format: ImageBufferFormat, width: number): ImageBuffer;
+    /** @internal */
+    protected static isValidData(data: Uint8Array, format: ImageBufferFormat, width: number): boolean;
+    /** @internal */
+    protected static computeHeight(data: Uint8Array, format: ImageBufferFormat, width: number): number;
+    /** @internal */
+    protected constructor(data: Uint8Array, format: ImageBufferFormat, width: number);
+}
+/** Returns whether the input is a power of two.
+ * @note Floating point inputs are truncated.
+ * @public
+ */
+export declare function isPowerOfTwo(num: number): boolean;
+/** Returns the first power-of-two value greater than or equal to the input.
+ * @note Floating point inputs are truncated.
+ * @public
+ */
+export declare function nextHighestPowerOfTwo(num: number): number;
+/** The format of an ImageSource.
+ * @public
+ * @extensions
+ */
+export declare enum ImageSourceFormat {
+    /** Image data is stored with JPEG compression. */
+    Jpeg = 0,
+    /** Image data is stored with PNG compression. */
+    Png = 2,
+    /** Image is stored as an Svg stream.
+     * @note SVG is only valid for ImageSources in JavaScript. It *may not* be used for persistent textures.
+     */
+    Svg = 3
+}
+/** @internal */
+export declare function isValidImageSourceFormat(format: ImageSourceFormat): boolean;
+/** Image data encoded and compressed in either Jpeg or Png format.
+ * @public
+ */
+export declare class ImageSource {
+    /** The content of the image, compressed */
+    readonly data: Uint8Array | string;
+    /** The compression type. */
+    readonly format: ImageSourceFormat;
+    /** Construct a new ImageSource, which takes ownership of the Uint8Array. */
+    constructor(data: Uint8Array | string, format: ImageSourceFormat);
+}
 //# sourceMappingURL=Image.d.ts.map

package/lib/cjs/Image.js

@@ -1,129 +1,129 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Rendering
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImageSource = exports.isValidImageSourceFormat = exports.ImageSourceFormat = exports.nextHighestPowerOfTwo = exports.isPowerOfTwo = exports.ImageBuffer = exports.ImageBufferFormat = void 0;
-/** Format of an [[ImageBuffer]].
- * The format determines how many bytes are allocated for each pixel in the buffer and the semantics of each byte.
- * @see [[ImageBuffer.getNumBytesPerPixel]]
- * @public
- * @extensions
- */
-var ImageBufferFormat;
-(function (ImageBufferFormat) {
-    /** RGBA format - 4 bytes per pixel. */
-    ImageBufferFormat[ImageBufferFormat["Rgba"] = 0] = "Rgba";
-    /** RGB format - 3 bytes per pixel. */
-    ImageBufferFormat[ImageBufferFormat["Rgb"] = 2] = "Rgb";
-    /** 1 byte per pixel. */
-    ImageBufferFormat[ImageBufferFormat["Alpha"] = 5] = "Alpha";
-})(ImageBufferFormat = exports.ImageBufferFormat || (exports.ImageBufferFormat = {}));
-/** Uncompressed rectangular bitmap image data.
- * @public
- */
-class ImageBuffer {
-    /** @internal */
-    constructor(data, format, width) {
-        this.data = data;
-        this.format = format;
-        this.width = width;
-    }
-    /** Return the number of bytes allocated for each pixel. */
-    get numBytesPerPixel() { return ImageBuffer.getNumBytesPerPixel(this.format); }
-    /** Determine the number of bytes allocated to a single pixel for the specified format. */
-    static getNumBytesPerPixel(format) {
-        switch (format) {
-            case ImageBufferFormat.Alpha: return 1;
-            case ImageBufferFormat.Rgb: return 3;
-            default: return 4;
-        }
-    }
-    /** Get the height of this image in pixels. */
-    get height() { return ImageBuffer.computeHeight(this.data, this.format, this.width); }
-    /** Create a new ImageBuffer.
-     * @note The ImageBuffer takes ownership of the input Uint8Array.
-     * @param data The uncompressed image bytes. Must be a multiple of the width times the number of bytes per pixel specified by the format.
-     * @param format The format of the image.
-     * @param width The width of the image in pixels.
-     * @returns A new ImageBuffer.
-     * @throws Error if the length of the Uint8Array is not appropriate for the specified width and format.
-     */
-    static create(data, format, width) {
-        if (!this.isValidData(data, format, width))
-            throw new Error("The number of bytes supplied for ImageBuffer do not match its width and format.");
-        return new ImageBuffer(data, format, width);
-    }
-    /** @internal */
-    static isValidData(data, format, width) {
-        const height = this.computeHeight(data, format, width);
-        return width > 0 && height > 0 && Math.floor(width) === width && Math.floor(height) === height;
-    }
-    /** @internal */
-    static computeHeight(data, format, width) {
-        return data.length / (width * this.getNumBytesPerPixel(format));
-    }
-}
-exports.ImageBuffer = ImageBuffer;
-/** Returns whether the input is a power of two.
- * @note Floating point inputs are truncated.
- * @public
- */
-function isPowerOfTwo(num) {
-    return 0 === (num & (num - 1));
-}
-exports.isPowerOfTwo = isPowerOfTwo;
-/** Returns the first power-of-two value greater than or equal to the input.
- * @note Floating point inputs are truncated.
- * @public
- */
-function nextHighestPowerOfTwo(num) {
-    --num;
-    for (let i = 1; i < 32; i <<= 1)
-        num = num | num >> i;
-    return num + 1;
-}
-exports.nextHighestPowerOfTwo = nextHighestPowerOfTwo;
-/** The format of an ImageSource.
- * @public
- * @extensions
- */
-var ImageSourceFormat;
-(function (ImageSourceFormat) {
-    /** Image data is stored with JPEG compression. */
-    ImageSourceFormat[ImageSourceFormat["Jpeg"] = 0] = "Jpeg";
-    /** Image data is stored with PNG compression. */
-    ImageSourceFormat[ImageSourceFormat["Png"] = 2] = "Png";
-    /** Image is stored as an Svg stream.
-     * @note SVG is only valid for ImageSources in JavaScript. It *may not* be used for persistent textures.
-     */
-    ImageSourceFormat[ImageSourceFormat["Svg"] = 3] = "Svg";
-})(ImageSourceFormat = exports.ImageSourceFormat || (exports.ImageSourceFormat = {}));
-/** @internal */
-function isValidImageSourceFormat(format) {
-    switch (format) {
-        case ImageSourceFormat.Jpeg:
-        case ImageSourceFormat.Png:
-        case ImageSourceFormat.Svg:
-            return true;
-        default:
-            return false;
-    }
-}
-exports.isValidImageSourceFormat = isValidImageSourceFormat;
-/** Image data encoded and compressed in either Jpeg or Png format.
- * @public
- */
-class ImageSource {
-    /** Construct a new ImageSource, which takes ownership of the Uint8Array. */
-    constructor(data, format) {
-        this.data = data;
-        this.format = format;
-    }
-}
-exports.ImageSource = ImageSource;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImageSource = exports.isValidImageSourceFormat = exports.ImageSourceFormat = exports.nextHighestPowerOfTwo = exports.isPowerOfTwo = exports.ImageBuffer = exports.ImageBufferFormat = void 0;
+/** Format of an [[ImageBuffer]].
+ * The format determines how many bytes are allocated for each pixel in the buffer and the semantics of each byte.
+ * @see [[ImageBuffer.getNumBytesPerPixel]]
+ * @public
+ * @extensions
+ */
+var ImageBufferFormat;
+(function (ImageBufferFormat) {
+    /** RGBA format - 4 bytes per pixel. */
+    ImageBufferFormat[ImageBufferFormat["Rgba"] = 0] = "Rgba";
+    /** RGB format - 3 bytes per pixel. */
+    ImageBufferFormat[ImageBufferFormat["Rgb"] = 2] = "Rgb";
+    /** 1 byte per pixel. */
+    ImageBufferFormat[ImageBufferFormat["Alpha"] = 5] = "Alpha";
+})(ImageBufferFormat = exports.ImageBufferFormat || (exports.ImageBufferFormat = {}));
+/** Uncompressed rectangular bitmap image data.
+ * @public
+ */
+class ImageBuffer {
+    /** @internal */
+    constructor(data, format, width) {
+        this.data = data;
+        this.format = format;
+        this.width = width;
+    }
+    /** Return the number of bytes allocated for each pixel. */
+    get numBytesPerPixel() { return ImageBuffer.getNumBytesPerPixel(this.format); }
+    /** Determine the number of bytes allocated to a single pixel for the specified format. */
+    static getNumBytesPerPixel(format) {
+        switch (format) {
+            case ImageBufferFormat.Alpha: return 1;
+            case ImageBufferFormat.Rgb: return 3;
+            default: return 4;
+        }
+    }
+    /** Get the height of this image in pixels. */
+    get height() { return ImageBuffer.computeHeight(this.data, this.format, this.width); }
+    /** Create a new ImageBuffer.
+     * @note The ImageBuffer takes ownership of the input Uint8Array.
+     * @param data The uncompressed image bytes. Must be a multiple of the width times the number of bytes per pixel specified by the format.
+     * @param format The format of the image.
+     * @param width The width of the image in pixels.
+     * @returns A new ImageBuffer.
+     * @throws Error if the length of the Uint8Array is not appropriate for the specified width and format.
+     */
+    static create(data, format, width) {
+        if (!this.isValidData(data, format, width))
+            throw new Error("The number of bytes supplied for ImageBuffer do not match its width and format.");
+        return new ImageBuffer(data, format, width);
+    }
+    /** @internal */
+    static isValidData(data, format, width) {
+        const height = this.computeHeight(data, format, width);
+        return width > 0 && height > 0 && Math.floor(width) === width && Math.floor(height) === height;
+    }
+    /** @internal */
+    static computeHeight(data, format, width) {
+        return data.length / (width * this.getNumBytesPerPixel(format));
+    }
+}
+exports.ImageBuffer = ImageBuffer;
+/** Returns whether the input is a power of two.
+ * @note Floating point inputs are truncated.
+ * @public
+ */
+function isPowerOfTwo(num) {
+    return 0 === (num & (num - 1));
+}
+exports.isPowerOfTwo = isPowerOfTwo;
+/** Returns the first power-of-two value greater than or equal to the input.
+ * @note Floating point inputs are truncated.
+ * @public
+ */
+function nextHighestPowerOfTwo(num) {
+    --num;
+    for (let i = 1; i < 32; i <<= 1)
+        num = num | num >> i;
+    return num + 1;
+}
+exports.nextHighestPowerOfTwo = nextHighestPowerOfTwo;
+/** The format of an ImageSource.
+ * @public
+ * @extensions
+ */
+var ImageSourceFormat;
+(function (ImageSourceFormat) {
+    /** Image data is stored with JPEG compression. */
+    ImageSourceFormat[ImageSourceFormat["Jpeg"] = 0] = "Jpeg";
+    /** Image data is stored with PNG compression. */
+    ImageSourceFormat[ImageSourceFormat["Png"] = 2] = "Png";
+    /** Image is stored as an Svg stream.
+     * @note SVG is only valid for ImageSources in JavaScript. It *may not* be used for persistent textures.
+     */
+    ImageSourceFormat[ImageSourceFormat["Svg"] = 3] = "Svg";
+})(ImageSourceFormat = exports.ImageSourceFormat || (exports.ImageSourceFormat = {}));
+/** @internal */
+function isValidImageSourceFormat(format) {
+    switch (format) {
+        case ImageSourceFormat.Jpeg:
+        case ImageSourceFormat.Png:
+        case ImageSourceFormat.Svg:
+            return true;
+        default:
+            return false;
+    }
+}
+exports.isValidImageSourceFormat = isValidImageSourceFormat;
+/** Image data encoded and compressed in either Jpeg or Png format.
+ * @public
+ */
+class ImageSource {
+    /** Construct a new ImageSource, which takes ownership of the Uint8Array. */
+    constructor(data, format) {
+        this.data = data;
+        this.format = format;
+    }
+}
+exports.ImageSource = ImageSource;
 //# sourceMappingURL=Image.js.map