@itwin/core-frontend 3.2.0-dev.9 → 3.3.0-dev.2

package/lib/esm/ImageUtil.js

@@ -32,6 +32,7 @@ function rgbaFromRgba(rgba, src, idx) {
  * @param barStyle CSS style string to apply to any side bars; defaults to "#C0C0C0", which is silver.
  * @returns an [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object containing the resized image and any requested side bars.
  * @public
+ * @extensions
  */
 export function canvasToResizedCanvasWithBars(canvasIn, targetSize, barSize = new Point2d(0, 0), barStyle = "#C0C0C0") {
     const canvasOut = document.createElement("canvas");
@@ -56,6 +57,7 @@ export function canvasToResizedCanvasWithBars(canvasIn, targetSize, barSize = ne
  * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).
  * @returns an [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object containing the contents of the source image buffer, or undefined if the conversion fails.
  * @public
+ * @extensions
  */
 export function imageBufferToCanvas(buffer, preserveAlpha = true) {
     const canvas = document.createElement("canvas");
@@ -88,6 +90,7 @@ export function imageBufferToCanvas(buffer, preserveAlpha = true) {
  * @param format the desired format of the created ImageBuffer; defaults to [[ImageBufferFormat.Rgba]].
  * @returns an [[ImageBuffer]] object containing the contents of the source canvas, or undefined if the conversion fails.
  * @public
+ * @extensions
  */
 export function canvasToImageBuffer(canvas, format = ImageBufferFormat.Rgba) {
     const context = canvas.getContext("2d");
@@ -132,6 +135,7 @@ export function canvasToImageBuffer(canvas, format = ImageBufferFormat.Rgba) {
 }
 /** Get a string describing the mime type associated with an ImageSource format.
  * @public
+ * @extensions
  */
 export function getImageSourceMimeType(format) {
     switch (format) {
@@ -146,6 +150,7 @@ export function getImageSourceMimeType(format) {
 }
 /** Get the ImageSourceFormat corresponding to the mime type string, or undefined if the string does not identify a supported ImageSourceFormat.
  * @public
+ * @extensions
  */
 export function getImageSourceFormatForMimeType(mimeType) {
     switch (mimeType) {
@@ -159,6 +164,7 @@ export function getImageSourceFormatForMimeType(mimeType) {
  * @param source The ImageSource containing the binary jpeg or png data.
  * @returns a Promise which resolves to an HTMLImageElement containing the uncompressed bitmap image in RGBA format.
  * @public
+ * @extensions
  */
 export async function imageElementFromImageSource(source) {
     const blob = new Blob([source.data], { type: getImageSourceMimeType(source.format) });
@@ -166,15 +172,19 @@ export async function imageElementFromImageSource(source) {
 }
 /** Create an html Image element from a URL.
  * @param url The URL pointing to the image data.
+ * @param skipCrossOriginCheck Set this to true to allow an image from a different origin than the web app to load. Default is false.
  * @returns A Promise resolving to an HTMLImageElement when the image data has been loaded from the URL.
  * @see tryImageElementFromUrl.
  * @public
+ * @extensions
  */
-export async function imageElementFromUrl(url) {
+export async function imageElementFromUrl(url, skipCrossOriginCheck = false) {
     // We must set crossorigin property so that images loaded from same origin can be used with texImage2d.
     // We must do that outside of the promise constructor or it won't work, for reasons.
     const image = new Image();
-    image.crossOrigin = "anonymous";
+    if (!skipCrossOriginCheck) {
+        image.crossOrigin = "anonymous";
+    }
     return new Promise((resolve, reject) => {
         image.onload = () => resolve(image);
         // The "error" produced by Image is not an Error. It looks like an Event, but isn't one.
@@ -184,13 +194,14 @@ export async function imageElementFromUrl(url) {
 }
 /** Try to create an html Image element from a URL.
  * @param url The URL pointing to the image data.
+ * @param skipCrossOriginCheck Set this to true to allow an image from a different origin than the web app to load. Default is false.
  * @returns A Promise resolving to an HTMLImageElement when the image data has been loaded from the URL, or to `undefined` if an exception occurred.
  * @see imageElementFromUrl
  * @public
  */
-export async function tryImageElementFromUrl(url) {
+export async function tryImageElementFromUrl(url, skipCrossOriginCheck = false) {
     try {
-        return await imageElementFromUrl(url);
+        return await imageElementFromUrl(url, skipCrossOriginCheck);
     }
     catch {
         return undefined;
@@ -201,6 +212,7 @@ export async function tryImageElementFromUrl(url) {
  * @param source The ImageSource containing the binary jpeg or png data.
  * @returns a Promise resolving to a Point2d of which x corresponds to the integer width of the uncompressed bitmap and y to the height.
  * @public
+ * @extensions
  */
 export async function extractImageSourceDimensions(source) {
     const image = await imageElementFromImageSource(source);
@@ -212,6 +224,7 @@ export async function extractImageSourceDimensions(source) {
  * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).
  * @returns a data url as a string suitable for setting as the `src` property of an HTMLImageElement, or undefined if the url could not be created.
  * @public
+ * @extensions
  */
 export function imageBufferToPngDataUrl(buffer, preserveAlpha = true) {
     // The default format (and the only format required to be supported) for toDataUrl() is "image/png".
@@ -224,6 +237,7 @@ export function imageBufferToPngDataUrl(buffer, preserveAlpha = true) {
  * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).
  * @returns a base64-encoded string representing the image as a PNG, or undefined if the conversion failed.
  * @public
+ * @extensions
  */
 export function imageBufferToBase64EncodedPng(buffer, preserveAlpha = true) {
     const urlPrefix = "data:image/png;base64,";
@@ -270,6 +284,7 @@ export function getCenteredViewRect(viewRect, aspectRatio = 1.4) {
  * @param minCompressionQuality The minimum acceptable image quality as a number between 0 (lowest quality) and 1 (highest quality).
  * @returns A [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) for the image, or `undefined` if the compression and size constraints could not be met.
  * @public
+ * @extensions
  */
 export function getCompressedJpegFromCanvas(canvas, maxBytes = 60000, minCompressionQuality = 0.1) {
     const decrements = 0.1; // Decrements of quality

package/lib/esm/ImageUtil.js.map

@@ -1 +1 @@
-{"version":3,"file":"ImageUtil.js","sourceRoot":"","sources":["../../src/ImageUtil.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAe,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACpG,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAStC,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAE/C,SAAS,aAAa,CAAC,IAAU,EAAE,GAAe,EAAE,GAAW;IAC7D,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7C,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAAC,IAAU,EAAE,GAAe,EAAE,GAAW;IAC3D,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;IACb,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,IAAU,EAAE,GAAe,EAAE,GAAW;IAC5D,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtB,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,6BAA6B,CAAC,QAA2B,EAAE,UAAmB,EAAE,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,GAAG,SAAS;IAC/I,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACnD,SAAS,CAAC,KAAK,GAAG,UAAU,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAC3C,SAAS,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAE5C,IAAI,YAAY,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,YAAY,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;IAEjC,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE;QACvB,YAAY,IAAI,GAAG,CAAC;KACrB;IACD,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE;QACvB,YAAY,IAAI,GAAG,CAAC;KACrB;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CAAE,CAAC;IAC5C,OAAO,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACpF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAmB,EAAE,gBAAyB,IAAI;IACpF,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,IAAI,KAAK,MAAM;QACjB,OAAO,SAAS,CAAC;IAEnB,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC5B,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAE9B,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,IAAI,KAAK,OAAO;QAClB,OAAO,SAAS,CAAC;IAEnB,MAAM,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACvE,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,GAAG,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;IAEvJ,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;IAC/B,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,MAAM,IAAI,GAAG,WAAW,CAAC;IACzB,OAAO,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE;QAC5B,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACrC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC/B,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC/B,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC/B,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACtD,CAAC,IAAI,CAAC,CAAC;KACR;IAED,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAyB,EAAE,MAAM,GAAG,iBAAiB,CAAC,IAAI;IAC5F,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,IAAI,KAAK,OAAO;QAClB,OAAO,SAAS,CAAC;IAEnB,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAE1E,IAAI,eAAuC,CAAC;IAE5C,IAAI,iBAAiB,CAAC,IAAI,KAAK,MAAM,EAAE;QACrC,eAAe,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KACzD;SAAM,IAAI,iBAAiB,CAAC,GAAG,KAAK,MAAM,EAAE;QAC3C,eAAe,GAAG,IAAI,UAAU,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACnE;SAAM,IAAI,iBAAiB,CAAC,KAAK,KAAK,MAAM,EAAE;QAC7C,eAAe,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KAC7D;IAED,IAAI,SAAS,KAAK,eAAe;QAC/B,OAAO,SAAS,CAAC;IAEnB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE;QAChC,IAAI,iBAAiB,CAAC,IAAI,KAAK,MAAM,EAAE;YACrC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,CAAC,IAAI,CAAC,CAAC;SACR;aAAM,IAAI,iBAAiB,CAAC,GAAG,KAAK,MAAM,EAAE;YAC3C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,CAAC,IAAI,CAAC,CAAC;SACR;aAAM,IAAI,iBAAiB,CAAC,KAAK,KAAK,MAAM,EAAE;YAC7C,eAAe,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,CAAC,EAAE,CAAC;SACL;QACD,CAAC,IAAI,CAAC,CAAC;KACR;IAED,OAAO,WAAW,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAAyB;IAE9D,QAAQ,MAAM,EAAE;QACd,KAAK,iBAAiB,CAAC,IAAI;YACzB,OAAO,YAAY,CAAC;QACtB,KAAK,iBAAiB,CAAC,GAAG;YACxB,OAAO,WAAW,CAAC;QACrB,KAAK,iBAAiB,CAAC,GAAG;YACxB,OAAO,6BAA6B,CAAC;KACxC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,+BAA+B,CAAC,QAAgB;IAC9D,QAAQ,QAAQ,EAAE;QAChB,KAAK,YAAY,CAAC,CAAC,OAAO,iBAAiB,CAAC,IAAI,CAAC;QACjD,KAAK,WAAW,CAAC,CAAC,OAAO,iBAAiB,CAAC,GAAG,CAAC;QAC/C,KAAK,6BAA6B,CAAC,CAAC,OAAO,iBAAiB,CAAC,GAAG,CAAC;QACjE,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;KAC3B;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,MAAmB;IACnE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtF,OAAO,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;AACxD,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,GAAW;IACnD,uGAAuG;IACvG,oFAAoF;IACpF,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;IAC1B,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAA0C,EAAE,MAAM,EAAE,EAAE;QACxE,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEpC,wFAAwF;QACxF,KAAK,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC,CAAC;QAC3E,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,GAAW;IACtD,IAAI;QACF,OAAO,MAAM,mBAAmB,CAAC,GAAG,CAAC,CAAC;KACvC;IAAC,MAAM;QACN,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AACD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,MAAmB;IACpE,MAAM,KAAK,GAAG,MAAM,2BAA2B,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAmB,EAAE,aAAa,GAAG,IAAI;IAC/E,oGAAoG;IACpG,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC1D,OAAO,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,6BAA6B,CAAC,MAAmB,EAAE,aAAa,GAAG,IAAI;IACrF,MAAM,SAAS,GAAG,wBAAwB,CAAC;IAC3C,MAAM,GAAG,GAAG,uBAAuB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3D,IAAI,SAAS,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC;QACjD,OAAO,SAAS,CAAC;IAEnB,OAAO,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,GAAW,EAAE,KAAc;IACrE,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAI,IAAI,KAAK,GAAG;QACd,OAAO;IAET,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9C,GAAG,CAAC,SAAS,GAAG,aAAa,GAAG,KAAK,CAAC;IACtC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,SAAS,KAAK,KAAK;QACrB,GAAG,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAkB,EAAE,WAAW,GAAG,GAAG;IACvE,0FAA0F;IAC1F,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,GAAG,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtE,MAAM,UAAU,GAAG,KAAK,GAAG,WAAW,CAAC;IACvC,MAAM,WAAW,GAAG,KAAK,CAAC;IAC1B,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,GAAG,UAAU,CAAC,GAAG,GAAG,CAAC;IACjD,MAAM,KAAK,GAAG,IAAI,GAAG,UAAU,CAAC;IAChC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,GAAG,CAAC;IAClD,MAAM,MAAM,GAAG,GAAG,GAAG,WAAW,CAAC;IACjC,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CAAC,MAAyB,EAAE,QAAQ,GAAG,KAAK,EAAE,qBAAqB,GAAG,GAAG;IAClH,MAAM,UAAU,GAAG,GAAG,CAAC,CAAC,wBAAwB;IAChD,MAAM,iBAAiB,GAAG,CAAC,CAAC,CAAC,8BAA8B;IAC3D,IAAI,OAAO,GAAG,GAAG,CAAC,CAAC,2BAA2B;IAE9C,OAAO,OAAO,GAAG,qBAAqB,EAAE;QACtC,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACrD,yCAAyC;QACzC,IAAI,IAAI,CAAC,MAAM,GAAG,iBAAiB,GAAG,QAAQ;YAC5C,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,UAAU,CAAC;KACvB;IAED,OAAO,SAAS,CAAC;AACnB,CAAC","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 Rendering\r\n */\r\n\r\nimport { Point2d } from \"@itwin/core-geometry\";\r\nimport { ImageBuffer, ImageBufferFormat, ImageSource, ImageSourceFormat } from \"@itwin/core-common\";\r\nimport { ViewRect } from \"./ViewRect\";\r\n\r\ninterface Rgba {\r\n  r: number;\r\n  g: number;\r\n  b: number;\r\n  a: number;\r\n}\r\n\r\nconst scratchRgba = { r: 0, g: 0, b: 0, a: 0 };\r\n\r\nfunction rgbaFromAlpha(rgba: Rgba, src: Uint8Array, idx: number): number {\r\n  rgba.r = rgba.g = rgba.b = rgba.a = src[idx];\r\n  return idx + 1;\r\n}\r\n\r\nfunction rgbaFromRgb(rgba: Rgba, src: Uint8Array, idx: number): number {\r\n  rgba.r = src[idx + 0];\r\n  rgba.g = src[idx + 1];\r\n  rgba.b = src[idx + 2];\r\n  rgba.a = 255;\r\n  return idx + 3;\r\n}\r\n\r\nfunction rgbaFromRgba(rgba: Rgba, src: Uint8Array, idx: number): number {\r\n  rgbaFromRgb(rgba, src, idx);\r\n  rgba.a = src[idx + 3];\r\n  return idx + 4;\r\n}\r\n\r\n/** Resize a canvas to a desired size.  The final size will be targetSize plus barSize.  The original canvas is left untouched and a new, resized canvas with potential side bars is returned.\r\n * @param canvasIn the source [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) to resize.\r\n * @param targetSize the desired new size for the canvas image.\r\n * @param barSize total size of side bars to add to the image in width and height; defaults to (0, 0).  For example, if you specify (2, 0), a 1 pixel side bar will be added to the left and right sides of the resized image.  If an odd dimension is specified, the left or upper side of the image will be one pixel larger than the opposite side.  For example, if you specify (1, 0), a 1 pixel side bar will be added to the left side of the image and a 0 pixel side bar will be added to the right side of the image.\r\n * @param barStyle CSS style string to apply to any side bars; defaults to \"#C0C0C0\", which is silver.\r\n * @returns an [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object containing the resized image and any requested side bars.\r\n * @public\r\n */\r\nexport function canvasToResizedCanvasWithBars(canvasIn: HTMLCanvasElement, targetSize: Point2d, barSize = new Point2d(0, 0), barStyle = \"#C0C0C0\"): HTMLCanvasElement {\r\n  const canvasOut = document.createElement(\"canvas\");\r\n  canvasOut.width = targetSize.x + barSize.x;\r\n  canvasOut.height = targetSize.y + barSize.y;\r\n\r\n  let adjustImageX = barSize.x / 2;\r\n  let adjustImageY = barSize.y / 2;\r\n\r\n  if (1 === barSize.x % 2) {\r\n    adjustImageX += 0.5;\r\n  }\r\n  if (1 === barSize.y % 2) {\r\n    adjustImageY += 0.5;\r\n  }\r\n\r\n  const context = canvasOut.getContext(\"2d\")!;\r\n  context.fillStyle = barStyle;\r\n  context.fillRect(0, 0, canvasOut.width, canvasOut.height);\r\n  context.drawImage(canvasIn, adjustImageX, adjustImageY, targetSize.x, targetSize.y);\r\n  return canvasOut;\r\n}\r\n\r\n/** Create a canvas element with the same dimensions and contents as an image buffer.\r\n * @param buffer the source [[ImageBuffer]] object from which the [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object will be constructed.\r\n * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).\r\n * @returns an [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object containing the contents of the source image buffer, or undefined if the conversion fails.\r\n * @public\r\n */\r\nexport function imageBufferToCanvas(buffer: ImageBuffer, preserveAlpha: boolean = true): HTMLCanvasElement | undefined {\r\n  const canvas = document.createElement(\"canvas\");\r\n  if (null === canvas)\r\n    return undefined;\r\n\r\n  canvas.width = buffer.width;\r\n  canvas.height = buffer.height;\r\n\r\n  const context = canvas.getContext(\"2d\");\r\n  if (null === context)\r\n    return undefined;\r\n\r\n  const imageData = context.createImageData(buffer.width, buffer.height);\r\n  const extractRgba = ImageBufferFormat.Alpha === buffer.format ? rgbaFromAlpha : (ImageBufferFormat.Rgb === buffer.format ? rgbaFromRgb : rgbaFromRgba);\r\n\r\n  const bufferData = buffer.data;\r\n  let i = 0;\r\n  let j = 0;\r\n  const rgba = scratchRgba;\r\n  while (i < bufferData.length) {\r\n    i = extractRgba(rgba, bufferData, i);\r\n    imageData.data[j + 0] = rgba.r;\r\n    imageData.data[j + 1] = rgba.g;\r\n    imageData.data[j + 2] = rgba.b;\r\n    imageData.data[j + 3] = preserveAlpha ? rgba.a : 0xff;\r\n    j += 4;\r\n  }\r\n\r\n  context.putImageData(imageData, 0, 0);\r\n  return canvas;\r\n}\r\n\r\n/** Create an ImageBuffer in the specified format with the same dimensions and contents as a canvas.\r\n * @param canvas the source [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object from which the [[ImageBuffer]] object will be constructed.\r\n * @param format the desired format of the created ImageBuffer; defaults to [[ImageBufferFormat.Rgba]].\r\n * @returns an [[ImageBuffer]] object containing the contents of the source canvas, or undefined if the conversion fails.\r\n * @public\r\n */\r\nexport function canvasToImageBuffer(canvas: HTMLCanvasElement, format = ImageBufferFormat.Rgba): ImageBuffer | undefined {\r\n  const context = canvas.getContext(\"2d\");\r\n  if (null === context)\r\n    return undefined;\r\n\r\n  const imageData = context.getImageData(0, 0, canvas.width, canvas.height);\r\n\r\n  let imageBufferData: Uint8Array | undefined;\r\n\r\n  if (ImageBufferFormat.Rgba === format) {\r\n    imageBufferData = new Uint8Array(imageData.data.length);\r\n  } else if (ImageBufferFormat.Rgb === format) {\r\n    imageBufferData = new Uint8Array((imageData.data.length / 4) * 3);\r\n  } else if (ImageBufferFormat.Alpha === format) {\r\n    imageBufferData = new Uint8Array(imageData.data.length / 4);\r\n  }\r\n\r\n  if (undefined === imageBufferData)\r\n    return undefined;\r\n\r\n  let i = 0;\r\n  let j = 0;\r\n  while (i < imageData.data.length) {\r\n    if (ImageBufferFormat.Rgba === format) {\r\n      imageBufferData[j + 0] = imageData.data[i + 0];\r\n      imageBufferData[j + 1] = imageData.data[i + 1];\r\n      imageBufferData[j + 2] = imageData.data[i + 2];\r\n      imageBufferData[j + 3] = imageData.data[i + 3];\r\n      j += 4;\r\n    } else if (ImageBufferFormat.Rgb === format) {\r\n      imageBufferData[j + 0] = imageData.data[i + 0];\r\n      imageBufferData[j + 1] = imageData.data[i + 1];\r\n      imageBufferData[j + 2] = imageData.data[i + 2];\r\n      j += 3;\r\n    } else if (ImageBufferFormat.Alpha === format) {\r\n      imageBufferData[j] = imageData.data[i + 3];\r\n      j++;\r\n    }\r\n    i += 4;\r\n  }\r\n\r\n  return ImageBuffer.create(imageBufferData, format, canvas.width);\r\n}\r\n\r\n/** Get a string describing the mime type associated with an ImageSource format.\r\n * @public\r\n */\r\nexport function getImageSourceMimeType(format: ImageSourceFormat): string {\r\n\r\n  switch (format) {\r\n    case ImageSourceFormat.Jpeg:\r\n      return \"image/jpeg\";\r\n    case ImageSourceFormat.Png:\r\n      return \"image/png\";\r\n    case ImageSourceFormat.Svg:\r\n      return \"image/svg+xml;charset=utf-8\";\r\n  }\r\n  return \"\";\r\n}\r\n\r\n/** Get the ImageSourceFormat corresponding to the mime type string, or undefined if the string does not identify a supported ImageSourceFormat.\r\n * @public\r\n */\r\nexport function getImageSourceFormatForMimeType(mimeType: string): ImageSourceFormat | undefined {\r\n  switch (mimeType) {\r\n    case \"image/jpeg\": return ImageSourceFormat.Jpeg;\r\n    case \"image/png\": return ImageSourceFormat.Png;\r\n    case \"image/svg+xml;charset=utf-8\": return ImageSourceFormat.Svg;\r\n    default: return undefined;\r\n  }\r\n}\r\n\r\n/** Extract an html Image element from a binary jpeg or png.\r\n * @param source The ImageSource containing the binary jpeg or png data.\r\n * @returns a Promise which resolves to an HTMLImageElement containing the uncompressed bitmap image in RGBA format.\r\n * @public\r\n */\r\nexport async function imageElementFromImageSource(source: ImageSource): Promise<HTMLImageElement> {\r\n  const blob = new Blob([source.data], { type: getImageSourceMimeType(source.format) });\r\n  return imageElementFromUrl(URL.createObjectURL(blob));\r\n}\r\n\r\n/** Create an html Image element from a URL.\r\n * @param url The URL pointing to the image data.\r\n * @returns A Promise resolving to an HTMLImageElement when the image data has been loaded from the URL.\r\n * @see tryImageElementFromUrl.\r\n * @public\r\n */\r\nexport async function imageElementFromUrl(url: string): Promise<HTMLImageElement> {\r\n  // We must set crossorigin property so that images loaded from same origin can be used with texImage2d.\r\n  // We must do that outside of the promise constructor or it won't work, for reasons.\r\n  const image = new Image();\r\n  image.crossOrigin = \"anonymous\";\r\n  return new Promise((resolve: (image: HTMLImageElement) => void, reject) => {\r\n    image.onload = () => resolve(image);\r\n\r\n    // The \"error\" produced by Image is not an Error. It looks like an Event, but isn't one.\r\n    image.onerror = () => reject(new Error(\"Failed to create image from url\"));\r\n    image.src = url;\r\n  });\r\n}\r\n\r\n/** Try to create an html Image element from a URL.\r\n * @param url The URL pointing to the image data.\r\n * @returns A Promise resolving to an HTMLImageElement when the image data has been loaded from the URL, or to `undefined` if an exception occurred.\r\n * @see imageElementFromUrl\r\n * @public\r\n */\r\nexport async function tryImageElementFromUrl(url: string): Promise<HTMLImageElement | undefined> {\r\n  try {\r\n    return await imageElementFromUrl(url);\r\n  } catch {\r\n    return undefined;\r\n  }\r\n}\r\n/**\r\n * Extract the dimensions of the jpeg or png data encoded in an ImageSource.\r\n * @param source The ImageSource containing the binary jpeg or png data.\r\n * @returns a Promise resolving to a Point2d of which x corresponds to the integer width of the uncompressed bitmap and y to the height.\r\n * @public\r\n */\r\nexport async function extractImageSourceDimensions(source: ImageSource): Promise<Point2d> {\r\n  const image = await imageElementFromImageSource(source);\r\n  return new Point2d(image.naturalWidth, image.naturalHeight);\r\n}\r\n\r\n/**\r\n * Produces a data url in \"image/png\" format from the contents of an ImageBuffer.\r\n * @param buffer The ImageBuffer, of any format.\r\n * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).\r\n * @returns a data url as a string suitable for setting as the `src` property of an HTMLImageElement, or undefined if the url could not be created.\r\n * @public\r\n */\r\nexport function imageBufferToPngDataUrl(buffer: ImageBuffer, preserveAlpha = true): string | undefined {\r\n  // The default format (and the only format required to be supported) for toDataUrl() is \"image/png\".\r\n  const canvas = imageBufferToCanvas(buffer, preserveAlpha);\r\n  return undefined !== canvas ? canvas.toDataURL() : undefined;\r\n}\r\n\r\n/**\r\n * Converts the contents of an ImageBuffer to PNG format.\r\n * @param buffer The ImageBuffer, of any format.\r\n * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).\r\n * @returns a base64-encoded string representing the image as a PNG, or undefined if the conversion failed.\r\n * @public\r\n */\r\nexport function imageBufferToBase64EncodedPng(buffer: ImageBuffer, preserveAlpha = true): string | undefined {\r\n  const urlPrefix = \"data:image/png;base64,\";\r\n  const url = imageBufferToPngDataUrl(buffer, preserveAlpha);\r\n  if (undefined === url || !url.startsWith(urlPrefix))\r\n    return undefined;\r\n\r\n  return url.substring(urlPrefix.length);\r\n}\r\n\r\n/** Open an image specified as a data URL in a new window or tab. Works around differences between browsers and Electron.\r\n * @param url The base64-encoded image URL.\r\n * @param title An optional title to apply to the new window.\r\n * @beta\r\n */\r\nexport function openImageDataUrlInNewWindow(url: string, title?: string): void {\r\n  const win = window.open();\r\n  if (null === win)\r\n    return;\r\n\r\n  const div = win.document.createElement(\"div\");\r\n  div.innerHTML = `<img src='${url}'/>`;\r\n  win.document.body.append(div);\r\n  if (undefined !== title)\r\n    win.document.title = title;\r\n}\r\n\r\n/** Determine the maximum [[ViewRect]] that can be fitted and centered in specified ViewRect given a required aspect ratio.\r\n * @param viewRect The rectangle in which the returned rectangle is to be centered and fitted.\r\n * @param aspectRatio Ratio of width to height.\r\n * @returns A ViewRect centered in the input rectangle.\r\n * @public\r\n */\r\nexport function getCenteredViewRect(viewRect: ViewRect, aspectRatio = 1.4): ViewRect {\r\n  // Determine scale that ensures ability to return an image with the prescribed aspectRatio\r\n  const scale = Math.min(viewRect.width / aspectRatio, viewRect.height);\r\n  const finalWidth = scale * aspectRatio;\r\n  const finalHeight = scale;\r\n  const left = (viewRect.width - finalWidth) / 2.0;\r\n  const right = left + finalWidth;\r\n  const top = (viewRect.height - finalHeight) / 2.0;\r\n  const bottom = top + finalHeight;\r\n  return new ViewRect(left, top, right, bottom);\r\n}\r\n\r\n/** Produce a jpeg compressed to no more than specified bytes and of no less than specified quality.\r\n * @param canvas Canvas containing the image to be compressed.\r\n * @param maxBytes Maximum size of output jpeg in bytes.\r\n * @param minCompressionQuality The minimum acceptable image quality as a number between 0 (lowest quality) and 1 (highest quality).\r\n * @returns A [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) for the image, or `undefined` if the compression and size constraints could not be met.\r\n * @public\r\n */\r\nexport function getCompressedJpegFromCanvas(canvas: HTMLCanvasElement, maxBytes = 60000, minCompressionQuality = 0.1): string | undefined {\r\n  const decrements = 0.1; // Decrements of quality\r\n  const bytesPerCharacter = 2; // Assume 16-bit per character\r\n  let quality = 1.0; // JPEG Compression quality\r\n\r\n  while (quality > minCompressionQuality) {\r\n    const data = canvas.toDataURL(\"image/jpeg\", quality);\r\n    // If we are less than 60 Kb, we are good\r\n    if (data.length * bytesPerCharacter < maxBytes)\r\n      return data;\r\n\r\n    quality -= decrements;\r\n  }\r\n\r\n  return undefined;\r\n}\r\n"]}
+{"version":3,"file":"ImageUtil.js","sourceRoot":"","sources":["../../src/ImageUtil.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAe,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACpG,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAStC,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAE/C,SAAS,aAAa,CAAC,IAAU,EAAE,GAAe,EAAE,GAAW;IAC7D,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7C,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAAC,IAAU,EAAE,GAAe,EAAE,GAAW;IAC3D,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtB,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;IACb,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,IAAU,EAAE,GAAe,EAAE,GAAW;IAC5D,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACtB,OAAO,GAAG,GAAG,CAAC,CAAC;AACjB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,6BAA6B,CAAC,QAA2B,EAAE,UAAmB,EAAE,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,GAAG,SAAS;IAC/I,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACnD,SAAS,CAAC,KAAK,GAAG,UAAU,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAC3C,SAAS,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAE5C,IAAI,YAAY,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,YAAY,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;IAEjC,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE;QACvB,YAAY,IAAI,GAAG,CAAC;KACrB;IACD,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE;QACvB,YAAY,IAAI,GAAG,CAAC;KACrB;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CAAE,CAAC;IAC5C,OAAO,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACpF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAmB,EAAE,gBAAyB,IAAI;IACpF,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,IAAI,KAAK,MAAM;QACjB,OAAO,SAAS,CAAC;IAEnB,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC5B,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAE9B,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,IAAI,KAAK,OAAO;QAClB,OAAO,SAAS,CAAC;IAEnB,MAAM,SAAS,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACvE,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,GAAG,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;IAEvJ,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;IAC/B,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,MAAM,IAAI,GAAG,WAAW,CAAC;IACzB,OAAO,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE;QAC5B,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACrC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC/B,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC/B,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAC/B,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACtD,CAAC,IAAI,CAAC,CAAC;KACR;IAED,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAyB,EAAE,MAAM,GAAG,iBAAiB,CAAC,IAAI;IAC5F,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,IAAI,KAAK,OAAO;QAClB,OAAO,SAAS,CAAC;IAEnB,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAE1E,IAAI,eAAuC,CAAC;IAE5C,IAAI,iBAAiB,CAAC,IAAI,KAAK,MAAM,EAAE;QACrC,eAAe,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KACzD;SAAM,IAAI,iBAAiB,CAAC,GAAG,KAAK,MAAM,EAAE;QAC3C,eAAe,GAAG,IAAI,UAAU,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACnE;SAAM,IAAI,iBAAiB,CAAC,KAAK,KAAK,MAAM,EAAE;QAC7C,eAAe,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KAC7D;IAED,IAAI,SAAS,KAAK,eAAe;QAC/B,OAAO,SAAS,CAAC;IAEnB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE;QAChC,IAAI,iBAAiB,CAAC,IAAI,KAAK,MAAM,EAAE;YACrC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,CAAC,IAAI,CAAC,CAAC;SACR;aAAM,IAAI,iBAAiB,CAAC,GAAG,KAAK,MAAM,EAAE;YAC3C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,CAAC,IAAI,CAAC,CAAC;SACR;aAAM,IAAI,iBAAiB,CAAC,KAAK,KAAK,MAAM,EAAE;YAC7C,eAAe,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,CAAC,EAAE,CAAC;SACL;QACD,CAAC,IAAI,CAAC,CAAC;KACR;IAED,OAAO,WAAW,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAAyB;IAE9D,QAAQ,MAAM,EAAE;QACd,KAAK,iBAAiB,CAAC,IAAI;YACzB,OAAO,YAAY,CAAC;QACtB,KAAK,iBAAiB,CAAC,GAAG;YACxB,OAAO,WAAW,CAAC;QACrB,KAAK,iBAAiB,CAAC,GAAG;YACxB,OAAO,6BAA6B,CAAC;KACxC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,+BAA+B,CAAC,QAAgB;IAC9D,QAAQ,QAAQ,EAAE;QAChB,KAAK,YAAY,CAAC,CAAC,OAAO,iBAAiB,CAAC,IAAI,CAAC;QACjD,KAAK,WAAW,CAAC,CAAC,OAAO,iBAAiB,CAAC,GAAG,CAAC;QAC/C,KAAK,6BAA6B,CAAC,CAAC,OAAO,iBAAiB,CAAC,GAAG,CAAC;QACjE,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;KAC3B;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAAC,MAAmB;IACnE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,sBAAsB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtF,OAAO,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,GAAW,EAAE,oBAAoB,GAAG,KAAK;IACjF,uGAAuG;IACvG,oFAAoF;IACpF,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;IAC1B,IAAI,CAAC,oBAAoB,EAAE;QACzB,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;KACjC;IACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAA0C,EAAE,MAAM,EAAE,EAAE;QACxE,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEpC,wFAAwF;QACxF,KAAK,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC,CAAC;QAC3E,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,GAAW,EAAE,oBAAoB,GAAG,KAAK;IACpF,IAAI;QACF,OAAO,MAAM,mBAAmB,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;KAC7D;IAAC,MAAM;QACN,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AACD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,MAAmB;IACpE,MAAM,KAAK,GAAG,MAAM,2BAA2B,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAmB,EAAE,aAAa,GAAG,IAAI;IAC/E,oGAAoG;IACpG,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC1D,OAAO,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,6BAA6B,CAAC,MAAmB,EAAE,aAAa,GAAG,IAAI;IACrF,MAAM,SAAS,GAAG,wBAAwB,CAAC;IAC3C,MAAM,GAAG,GAAG,uBAAuB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3D,IAAI,SAAS,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC;QACjD,OAAO,SAAS,CAAC;IAEnB,OAAO,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,GAAW,EAAE,KAAc;IACrE,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAI,IAAI,KAAK,GAAG;QACd,OAAO;IAET,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9C,GAAG,CAAC,SAAS,GAAG,aAAa,GAAG,KAAK,CAAC;IACtC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,SAAS,KAAK,KAAK;QACrB,GAAG,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAkB,EAAE,WAAW,GAAG,GAAG;IACvE,0FAA0F;IAC1F,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,GAAG,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtE,MAAM,UAAU,GAAG,KAAK,GAAG,WAAW,CAAC;IACvC,MAAM,WAAW,GAAG,KAAK,CAAC;IAC1B,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,GAAG,UAAU,CAAC,GAAG,GAAG,CAAC;IACjD,MAAM,KAAK,GAAG,IAAI,GAAG,UAAU,CAAC;IAChC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,GAAG,CAAC;IAClD,MAAM,MAAM,GAAG,GAAG,GAAG,WAAW,CAAC;IACjC,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,2BAA2B,CAAC,MAAyB,EAAE,QAAQ,GAAG,KAAK,EAAE,qBAAqB,GAAG,GAAG;IAClH,MAAM,UAAU,GAAG,GAAG,CAAC,CAAC,wBAAwB;IAChD,MAAM,iBAAiB,GAAG,CAAC,CAAC,CAAC,8BAA8B;IAC3D,IAAI,OAAO,GAAG,GAAG,CAAC,CAAC,2BAA2B;IAE9C,OAAO,OAAO,GAAG,qBAAqB,EAAE;QACtC,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACrD,yCAAyC;QACzC,IAAI,IAAI,CAAC,MAAM,GAAG,iBAAiB,GAAG,QAAQ;YAC5C,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,UAAU,CAAC;KACvB;IAED,OAAO,SAAS,CAAC;AACnB,CAAC","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 Rendering\r\n */\r\n\r\nimport { Point2d } from \"@itwin/core-geometry\";\r\nimport { ImageBuffer, ImageBufferFormat, ImageSource, ImageSourceFormat } from \"@itwin/core-common\";\r\nimport { ViewRect } from \"./ViewRect\";\r\n\r\ninterface Rgba {\r\n  r: number;\r\n  g: number;\r\n  b: number;\r\n  a: number;\r\n}\r\n\r\nconst scratchRgba = { r: 0, g: 0, b: 0, a: 0 };\r\n\r\nfunction rgbaFromAlpha(rgba: Rgba, src: Uint8Array, idx: number): number {\r\n  rgba.r = rgba.g = rgba.b = rgba.a = src[idx];\r\n  return idx + 1;\r\n}\r\n\r\nfunction rgbaFromRgb(rgba: Rgba, src: Uint8Array, idx: number): number {\r\n  rgba.r = src[idx + 0];\r\n  rgba.g = src[idx + 1];\r\n  rgba.b = src[idx + 2];\r\n  rgba.a = 255;\r\n  return idx + 3;\r\n}\r\n\r\nfunction rgbaFromRgba(rgba: Rgba, src: Uint8Array, idx: number): number {\r\n  rgbaFromRgb(rgba, src, idx);\r\n  rgba.a = src[idx + 3];\r\n  return idx + 4;\r\n}\r\n\r\n/** Resize a canvas to a desired size.  The final size will be targetSize plus barSize.  The original canvas is left untouched and a new, resized canvas with potential side bars is returned.\r\n * @param canvasIn the source [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) to resize.\r\n * @param targetSize the desired new size for the canvas image.\r\n * @param barSize total size of side bars to add to the image in width and height; defaults to (0, 0).  For example, if you specify (2, 0), a 1 pixel side bar will be added to the left and right sides of the resized image.  If an odd dimension is specified, the left or upper side of the image will be one pixel larger than the opposite side.  For example, if you specify (1, 0), a 1 pixel side bar will be added to the left side of the image and a 0 pixel side bar will be added to the right side of the image.\r\n * @param barStyle CSS style string to apply to any side bars; defaults to \"#C0C0C0\", which is silver.\r\n * @returns an [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object containing the resized image and any requested side bars.\r\n * @public\r\n * @extensions\r\n */\r\nexport function canvasToResizedCanvasWithBars(canvasIn: HTMLCanvasElement, targetSize: Point2d, barSize = new Point2d(0, 0), barStyle = \"#C0C0C0\"): HTMLCanvasElement {\r\n  const canvasOut = document.createElement(\"canvas\");\r\n  canvasOut.width = targetSize.x + barSize.x;\r\n  canvasOut.height = targetSize.y + barSize.y;\r\n\r\n  let adjustImageX = barSize.x / 2;\r\n  let adjustImageY = barSize.y / 2;\r\n\r\n  if (1 === barSize.x % 2) {\r\n    adjustImageX += 0.5;\r\n  }\r\n  if (1 === barSize.y % 2) {\r\n    adjustImageY += 0.5;\r\n  }\r\n\r\n  const context = canvasOut.getContext(\"2d\")!;\r\n  context.fillStyle = barStyle;\r\n  context.fillRect(0, 0, canvasOut.width, canvasOut.height);\r\n  context.drawImage(canvasIn, adjustImageX, adjustImageY, targetSize.x, targetSize.y);\r\n  return canvasOut;\r\n}\r\n\r\n/** Create a canvas element with the same dimensions and contents as an image buffer.\r\n * @param buffer the source [[ImageBuffer]] object from which the [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object will be constructed.\r\n * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).\r\n * @returns an [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object containing the contents of the source image buffer, or undefined if the conversion fails.\r\n * @public\r\n * @extensions\r\n */\r\nexport function imageBufferToCanvas(buffer: ImageBuffer, preserveAlpha: boolean = true): HTMLCanvasElement | undefined {\r\n  const canvas = document.createElement(\"canvas\");\r\n  if (null === canvas)\r\n    return undefined;\r\n\r\n  canvas.width = buffer.width;\r\n  canvas.height = buffer.height;\r\n\r\n  const context = canvas.getContext(\"2d\");\r\n  if (null === context)\r\n    return undefined;\r\n\r\n  const imageData = context.createImageData(buffer.width, buffer.height);\r\n  const extractRgba = ImageBufferFormat.Alpha === buffer.format ? rgbaFromAlpha : (ImageBufferFormat.Rgb === buffer.format ? rgbaFromRgb : rgbaFromRgba);\r\n\r\n  const bufferData = buffer.data;\r\n  let i = 0;\r\n  let j = 0;\r\n  const rgba = scratchRgba;\r\n  while (i < bufferData.length) {\r\n    i = extractRgba(rgba, bufferData, i);\r\n    imageData.data[j + 0] = rgba.r;\r\n    imageData.data[j + 1] = rgba.g;\r\n    imageData.data[j + 2] = rgba.b;\r\n    imageData.data[j + 3] = preserveAlpha ? rgba.a : 0xff;\r\n    j += 4;\r\n  }\r\n\r\n  context.putImageData(imageData, 0, 0);\r\n  return canvas;\r\n}\r\n\r\n/** Create an ImageBuffer in the specified format with the same dimensions and contents as a canvas.\r\n * @param canvas the source [HTMLCanvasElement](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement) object from which the [[ImageBuffer]] object will be constructed.\r\n * @param format the desired format of the created ImageBuffer; defaults to [[ImageBufferFormat.Rgba]].\r\n * @returns an [[ImageBuffer]] object containing the contents of the source canvas, or undefined if the conversion fails.\r\n * @public\r\n * @extensions\r\n */\r\nexport function canvasToImageBuffer(canvas: HTMLCanvasElement, format = ImageBufferFormat.Rgba): ImageBuffer | undefined {\r\n  const context = canvas.getContext(\"2d\");\r\n  if (null === context)\r\n    return undefined;\r\n\r\n  const imageData = context.getImageData(0, 0, canvas.width, canvas.height);\r\n\r\n  let imageBufferData: Uint8Array | undefined;\r\n\r\n  if (ImageBufferFormat.Rgba === format) {\r\n    imageBufferData = new Uint8Array(imageData.data.length);\r\n  } else if (ImageBufferFormat.Rgb === format) {\r\n    imageBufferData = new Uint8Array((imageData.data.length / 4) * 3);\r\n  } else if (ImageBufferFormat.Alpha === format) {\r\n    imageBufferData = new Uint8Array(imageData.data.length / 4);\r\n  }\r\n\r\n  if (undefined === imageBufferData)\r\n    return undefined;\r\n\r\n  let i = 0;\r\n  let j = 0;\r\n  while (i < imageData.data.length) {\r\n    if (ImageBufferFormat.Rgba === format) {\r\n      imageBufferData[j + 0] = imageData.data[i + 0];\r\n      imageBufferData[j + 1] = imageData.data[i + 1];\r\n      imageBufferData[j + 2] = imageData.data[i + 2];\r\n      imageBufferData[j + 3] = imageData.data[i + 3];\r\n      j += 4;\r\n    } else if (ImageBufferFormat.Rgb === format) {\r\n      imageBufferData[j + 0] = imageData.data[i + 0];\r\n      imageBufferData[j + 1] = imageData.data[i + 1];\r\n      imageBufferData[j + 2] = imageData.data[i + 2];\r\n      j += 3;\r\n    } else if (ImageBufferFormat.Alpha === format) {\r\n      imageBufferData[j] = imageData.data[i + 3];\r\n      j++;\r\n    }\r\n    i += 4;\r\n  }\r\n\r\n  return ImageBuffer.create(imageBufferData, format, canvas.width);\r\n}\r\n\r\n/** Get a string describing the mime type associated with an ImageSource format.\r\n * @public\r\n * @extensions\r\n */\r\nexport function getImageSourceMimeType(format: ImageSourceFormat): string {\r\n\r\n  switch (format) {\r\n    case ImageSourceFormat.Jpeg:\r\n      return \"image/jpeg\";\r\n    case ImageSourceFormat.Png:\r\n      return \"image/png\";\r\n    case ImageSourceFormat.Svg:\r\n      return \"image/svg+xml;charset=utf-8\";\r\n  }\r\n  return \"\";\r\n}\r\n\r\n/** Get the ImageSourceFormat corresponding to the mime type string, or undefined if the string does not identify a supported ImageSourceFormat.\r\n * @public\r\n * @extensions\r\n */\r\nexport function getImageSourceFormatForMimeType(mimeType: string): ImageSourceFormat | undefined {\r\n  switch (mimeType) {\r\n    case \"image/jpeg\": return ImageSourceFormat.Jpeg;\r\n    case \"image/png\": return ImageSourceFormat.Png;\r\n    case \"image/svg+xml;charset=utf-8\": return ImageSourceFormat.Svg;\r\n    default: return undefined;\r\n  }\r\n}\r\n\r\n/** Extract an html Image element from a binary jpeg or png.\r\n * @param source The ImageSource containing the binary jpeg or png data.\r\n * @returns a Promise which resolves to an HTMLImageElement containing the uncompressed bitmap image in RGBA format.\r\n * @public\r\n * @extensions\r\n */\r\nexport async function imageElementFromImageSource(source: ImageSource): Promise<HTMLImageElement> {\r\n  const blob = new Blob([source.data], { type: getImageSourceMimeType(source.format) });\r\n  return imageElementFromUrl(URL.createObjectURL(blob));\r\n}\r\n\r\n/** Create an html Image element from a URL.\r\n * @param url The URL pointing to the image data.\r\n * @param skipCrossOriginCheck Set this to true to allow an image from a different origin than the web app to load. Default is false.\r\n * @returns A Promise resolving to an HTMLImageElement when the image data has been loaded from the URL.\r\n * @see tryImageElementFromUrl.\r\n * @public\r\n * @extensions\r\n */\r\nexport async function imageElementFromUrl(url: string, skipCrossOriginCheck = false): Promise<HTMLImageElement> {\r\n  // We must set crossorigin property so that images loaded from same origin can be used with texImage2d.\r\n  // We must do that outside of the promise constructor or it won't work, for reasons.\r\n  const image = new Image();\r\n  if (!skipCrossOriginCheck) {\r\n    image.crossOrigin = \"anonymous\";\r\n  }\r\n  return new Promise((resolve: (image: HTMLImageElement) => void, reject) => {\r\n    image.onload = () => resolve(image);\r\n\r\n    // The \"error\" produced by Image is not an Error. It looks like an Event, but isn't one.\r\n    image.onerror = () => reject(new Error(\"Failed to create image from url\"));\r\n    image.src = url;\r\n  });\r\n}\r\n\r\n/** Try to create an html Image element from a URL.\r\n * @param url The URL pointing to the image data.\r\n * @param skipCrossOriginCheck Set this to true to allow an image from a different origin than the web app to load. Default is false.\r\n * @returns A Promise resolving to an HTMLImageElement when the image data has been loaded from the URL, or to `undefined` if an exception occurred.\r\n * @see imageElementFromUrl\r\n * @public\r\n */\r\nexport async function tryImageElementFromUrl(url: string, skipCrossOriginCheck = false): Promise<HTMLImageElement | undefined> {\r\n  try {\r\n    return await imageElementFromUrl(url, skipCrossOriginCheck);\r\n  } catch {\r\n    return undefined;\r\n  }\r\n}\r\n/**\r\n * Extract the dimensions of the jpeg or png data encoded in an ImageSource.\r\n * @param source The ImageSource containing the binary jpeg or png data.\r\n * @returns a Promise resolving to a Point2d of which x corresponds to the integer width of the uncompressed bitmap and y to the height.\r\n * @public\r\n * @extensions\r\n */\r\nexport async function extractImageSourceDimensions(source: ImageSource): Promise<Point2d> {\r\n  const image = await imageElementFromImageSource(source);\r\n  return new Point2d(image.naturalWidth, image.naturalHeight);\r\n}\r\n\r\n/**\r\n * Produces a data url in \"image/png\" format from the contents of an ImageBuffer.\r\n * @param buffer The ImageBuffer, of any format.\r\n * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).\r\n * @returns a data url as a string suitable for setting as the `src` property of an HTMLImageElement, or undefined if the url could not be created.\r\n * @public\r\n * @extensions\r\n */\r\nexport function imageBufferToPngDataUrl(buffer: ImageBuffer, preserveAlpha = true): string | undefined {\r\n  // The default format (and the only format required to be supported) for toDataUrl() is \"image/png\".\r\n  const canvas = imageBufferToCanvas(buffer, preserveAlpha);\r\n  return undefined !== canvas ? canvas.toDataURL() : undefined;\r\n}\r\n\r\n/**\r\n * Converts the contents of an ImageBuffer to PNG format.\r\n * @param buffer The ImageBuffer, of any format.\r\n * @param preserveAlpha If false, the alpha channel will be set to 255 (fully opaque). This is recommended when converting an already-blended image (e.g., one obtained from [[Viewport.readImageBuffer]]).\r\n * @returns a base64-encoded string representing the image as a PNG, or undefined if the conversion failed.\r\n * @public\r\n * @extensions\r\n */\r\nexport function imageBufferToBase64EncodedPng(buffer: ImageBuffer, preserveAlpha = true): string | undefined {\r\n  const urlPrefix = \"data:image/png;base64,\";\r\n  const url = imageBufferToPngDataUrl(buffer, preserveAlpha);\r\n  if (undefined === url || !url.startsWith(urlPrefix))\r\n    return undefined;\r\n\r\n  return url.substring(urlPrefix.length);\r\n}\r\n\r\n/** Open an image specified as a data URL in a new window or tab. Works around differences between browsers and Electron.\r\n * @param url The base64-encoded image URL.\r\n * @param title An optional title to apply to the new window.\r\n * @beta\r\n */\r\nexport function openImageDataUrlInNewWindow(url: string, title?: string): void {\r\n  const win = window.open();\r\n  if (null === win)\r\n    return;\r\n\r\n  const div = win.document.createElement(\"div\");\r\n  div.innerHTML = `<img src='${url}'/>`;\r\n  win.document.body.append(div);\r\n  if (undefined !== title)\r\n    win.document.title = title;\r\n}\r\n\r\n/** Determine the maximum [[ViewRect]] that can be fitted and centered in specified ViewRect given a required aspect ratio.\r\n * @param viewRect The rectangle in which the returned rectangle is to be centered and fitted.\r\n * @param aspectRatio Ratio of width to height.\r\n * @returns A ViewRect centered in the input rectangle.\r\n * @public\r\n */\r\nexport function getCenteredViewRect(viewRect: ViewRect, aspectRatio = 1.4): ViewRect {\r\n  // Determine scale that ensures ability to return an image with the prescribed aspectRatio\r\n  const scale = Math.min(viewRect.width / aspectRatio, viewRect.height);\r\n  const finalWidth = scale * aspectRatio;\r\n  const finalHeight = scale;\r\n  const left = (viewRect.width - finalWidth) / 2.0;\r\n  const right = left + finalWidth;\r\n  const top = (viewRect.height - finalHeight) / 2.0;\r\n  const bottom = top + finalHeight;\r\n  return new ViewRect(left, top, right, bottom);\r\n}\r\n\r\n/** Produce a jpeg compressed to no more than specified bytes and of no less than specified quality.\r\n * @param canvas Canvas containing the image to be compressed.\r\n * @param maxBytes Maximum size of output jpeg in bytes.\r\n * @param minCompressionQuality The minimum acceptable image quality as a number between 0 (lowest quality) and 1 (highest quality).\r\n * @returns A [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) for the image, or `undefined` if the compression and size constraints could not be met.\r\n * @public\r\n * @extensions\r\n */\r\nexport function getCompressedJpegFromCanvas(canvas: HTMLCanvasElement, maxBytes = 60000, minCompressionQuality = 0.1): string | undefined {\r\n  const decrements = 0.1; // Decrements of quality\r\n  const bytesPerCharacter = 2; // Assume 16-bit per character\r\n  let quality = 1.0; // JPEG Compression quality\r\n\r\n  while (quality > minCompressionQuality) {\r\n    const data = canvas.toDataURL(\"image/jpeg\", quality);\r\n    // If we are less than 60 Kb, we are good\r\n    if (data.length * bytesPerCharacter < maxBytes)\r\n      return data;\r\n\r\n    quality -= decrements;\r\n  }\r\n\r\n  return undefined;\r\n}\r\n"]}

package/lib/esm/IpcApp.d.ts

@@ -86,6 +86,7 @@ export declare class IpcApp {
  *
  * Then, call `MyNotificationHandler.register` at startup to connect your class to your channel.
  * @public
+ * @extensions
  */
 export declare abstract class NotificationHandler {
     /** All subclasses must implement this method to specify their response channel name. */

package/lib/esm/IpcApp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IpcApp.d.ts","sourceRoot":"","sources":["../../src/IpcApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EACmD,eAAe,EAAwC,WAAW,EAAE,iBAAiB,EAC/H,cAAc,EAC7B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAa,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B;AAED;;;GAGG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAgC;IACnD,qEAAqE;IAErE,OAAO,CAAC,MAAM,KAAK,GAAG,GAA4C;IAElE,iIAAiI;IACjI,WAAkB,OAAO,IAAI,OAAO,CAAoC;IAExE;;;;;;;OAOG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,cAAc;IAIhF;;;;OAIG;WACW,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW;IAInE;;;;;;;;;OASG;WACiB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzE;;;;;;OAMG;WACW,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAIlD;;;;;;;;;;OAUG;WACiB,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAUrF,WAAW,CAAC,CAAC,SAAS,cAAc,CAAC,eAAe,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAIjI;qFACiF;WAC7D,OAAO,CAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,aAAa;IAMxE,gBAAgB;WACI,QAAQ;CAI7B;AAED;;;;;;;;;;;;GAYG;AACH,8BAAsB,mBAAmB;IACvC,wFAAwF;IACxF,aAAoB,WAAW,IAAI,MAAM,CAAC;IAEnC,YAAY,IAAI,cAAc;IAUrC;;;;;OAKG;WACW,QAAQ,IAAI,cAAc;CAGzC"}
+{"version":3,"file":"IpcApp.d.ts","sourceRoot":"","sources":["../../src/IpcApp.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EACmD,eAAe,EAAwC,WAAW,EAAE,iBAAiB,EAC/H,cAAc,EAC7B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAa,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,EAAE,gBAAgB,CAAC;CAC9B;AAED;;;GAGG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAgC;IACnD,qEAAqE;IAErE,OAAO,CAAC,MAAM,KAAK,GAAG,GAA4C;IAElE,iIAAiI;IACjI,WAAkB,OAAO,IAAI,OAAO,CAAoC;IAExE;;;;;;;OAOG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,cAAc;IAIhF;;;;OAIG;WACW,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW;IAInE;;;;;;;;;OASG;WACiB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzE;;;;;;OAMG;WACW,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAIlD;;;;;;;;;;OAUG;WACiB,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAUrF,WAAW,CAAC,CAAC,SAAS,cAAc,CAAC,eAAe,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAIjI;qFACiF;WAC7D,OAAO,CAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,aAAa;IAMxE,gBAAgB;WACI,QAAQ;CAI7B;AAED;;;;;;;;;;;;;GAaG;AACH,8BAAsB,mBAAmB;IACvC,wFAAwF;IACxF,aAAoB,WAAW,IAAI,MAAM,CAAC;IAEnC,YAAY,IAAI,cAAc;IAUrC;;;;;OAKG;WACW,QAAQ,IAAI,cAAc;CAGzC"}

package/lib/esm/IpcApp.js

@@ -106,6 +106,7 @@ export class IpcApp {
  *
  * Then, call `MyNotificationHandler.register` at startup to connect your class to your channel.
  * @public
+ * @extensions
  */
 export class NotificationHandler {
     registerImpl() {

package/lib/esm/IpcApp.js.map

@@ -1 +1 @@
-{"version":3,"file":"IpcApp.js","sourceRoot":"","sources":["../../src/IpcApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACL,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EACtD,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAU1D;;;GAGG;AACH,MAAM,OAAO,MAAM;IAEjB,qEAAqE;IAE7D,MAAM,KAAK,GAAG,KAAwB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC;IAElE,iIAAiI;IAC1H,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,OAAoB;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,OAAe,EAAE,QAAqB;QACjE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,GAAG,IAAW;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAmB,EAAE,UAAkB,EAAE,GAAG,IAAW;QACxF,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAoB,CAAC;QACxF,IAAI,SAAS,KAAK,MAAM,CAAC,KAAK,EAAE;YAC9B,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC/B,MAAM,GAAG,CAAC;SACX;QACD,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,WAAW,CAA4C,UAAa,EAAE,GAAG,IAAoC;QAC/H,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAA0C,CAAC;IACpH,CAAC;IAED;qFACiF;IAC1E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QACtE,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAgB,mBAAmB;IAIhC,YAAY;QACjB,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAAE,EAAE;YAC5F,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;YACrC,IAAI,OAAO,IAAI,KAAK,UAAU;gBAC5B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,8DAA8D,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAErL,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,OAAQ,IAAK,IAAY,EAA0B,CAAC,YAAY,EAAE,CAAC,CAAC,uFAAuF;IAC7J,CAAC;CACF;AAED,wCAAwC;AACxC,MAAM,mBAAoB,SAAQ,mBAAmB;IACnD,IAAW,WAAW,KAAK,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,SAAS,KAAK,CAAC;CACvB","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 NativeApp\r\n */\r\n\r\nimport { AsyncMethodsOf, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport {\r\n  BackendError, IModelError, IModelStatus, IpcAppChannel, IpcAppFunctions, IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketFrontend,\r\n  iTwinChannel, RemoveFunction,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\r\n\r\n/**\r\n * Options for [[IpcApp.startup]]\r\n * @public\r\n */\r\nexport interface IpcAppOptions {\r\n  iModelApp?: IModelAppOptions;\r\n}\r\n\r\n/**\r\n * The frontend of apps with a dedicated backend that can use [Ipc]($docs/learning/IpcInterface.md).\r\n * @public\r\n */\r\nexport class IpcApp {\r\n  private static _ipc: IpcSocketFrontend | undefined;\r\n  /** Get the implementation of the [[IpcSocketFrontend]] interface. */\r\n\r\n  private static get ipc(): IpcSocketFrontend { return this._ipc!; }\r\n\r\n  /** Determine whether Ipc is available for this frontend. This will only be true if [[startup]] has been called on this class. */\r\n  public static get isValid(): boolean { return undefined !== this._ipc; }\r\n\r\n  /**\r\n   * Establish a message handler function for the supplied channel over Ipc. The handler will be called when messages are sent for\r\n   * the channel via  [[BackendIpc.send]].\r\n   * @param channel the name of the channel\r\n   * @param handler the message handler\r\n   * @returns A function to remove the handler\r\n   * @note Ipc is only supported if [[isValid]] is true.\r\n   */\r\n  public static addListener(channel: string, handler: IpcListener): RemoveFunction {\r\n    return this.ipc.addListener(iTwinChannel(channel), handler);\r\n  }\r\n\r\n  /**\r\n   * Remove a previously registered listener\r\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\r\n   * @param listener The function passed to [[addListener]]\r\n   */\r\n  public static removeListener(channel: string, listener: IpcListener) {\r\n    this.ipc.removeListener(iTwinChannel(channel), listener);\r\n  }\r\n\r\n  /**\r\n   * Send a message to the backend via `channel` and expect a result asynchronously. The handler must be established on the backend via [[BackendIpc.handle]]\r\n   * @param channel The name of the channel for the method.\r\n   * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.\r\n   * Note that this interface may be implemented via Electron for desktop apps, or via\r\n   * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based\r\n   * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.\r\n   * @note `args` are serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  public static async invoke(channel: string, ...args: any[]): Promise<any> {\r\n    return this.ipc.invoke(iTwinChannel(channel), ...args);\r\n  }\r\n\r\n  /**\r\n   * Send a message over the socket.\r\n   * @param channel The name of the channel for the message.\r\n   * @param data The optional data of the message.\r\n   * @note `data` is serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  public static send(channel: string, ...data: any[]) {\r\n    return this.ipc.send(iTwinChannel(channel), ...data);\r\n  }\r\n\r\n  /**\r\n   * Call a method on the backend through an Ipc channel.\r\n   * @param channelName the channel registered by the backend handler.\r\n   * @param methodName  the name of a method implemented by the backend handler.\r\n   * @param args arguments to `methodName`\r\n   * @return a Promise with the return value from `methodName`\r\n   * @note If the backend implementation throws an exception, this method will throw a [[BackendError]] exception\r\n   * with the `errorNumber` and `message` from the backend.\r\n   * @note Ipc is only supported if [[isValid]] is true.\r\n   * @internal\r\n   */\r\n  public static async callIpcChannel(channelName: string, methodName: string, ...args: any[]): Promise<any> {\r\n    const retVal = (await this.invoke(channelName, methodName, ...args)) as IpcInvokeReturn;\r\n    if (undefined !== retVal.error) {\r\n      const err = new BackendError(retVal.error.errorNumber, retVal.error.name, retVal.error.message);\r\n      err.stack = retVal.error.stack;\r\n      throw err;\r\n    }\r\n    return retVal.result;\r\n  }\r\n\r\n  public static async callIpcHost<T extends AsyncMethodsOf<IpcAppFunctions>>(methodName: T, ...args: Parameters<IpcAppFunctions[T]>) {\r\n    return this.callIpcChannel(IpcAppChannel.Functions, methodName, ...args) as PromiseReturnType<IpcAppFunctions[T]>;\r\n  }\r\n\r\n  /** start an IpcApp.\r\n   * @note this should not be called directly. It is called by NativeApp.startup */\r\n  public static async startup(ipc: IpcSocketFrontend, opts?: IpcAppOptions) {\r\n    this._ipc = ipc;\r\n    IpcAppNotifyHandler.register(); // receives notifications from backend\r\n    await IModelApp.startup(opts?.iModelApp);\r\n  }\r\n\r\n  /** @internal */\r\n  public static async shutdown() {\r\n    this._ipc = undefined;\r\n    await IModelApp.shutdown();\r\n  }\r\n}\r\n\r\n/**\r\n * Base class for all implementations of an Ipc notification response interface. This class is implemented on your frontend to supply\r\n * methods to receive notifications from your backend.\r\n *\r\n * Create a subclass to implement your Ipc response interface. Your class should be declared like this:\r\n * ```ts\r\n * class MyNotificationHandler extends NotificationHandler implements MyNotifications\r\n * ```\r\n * to ensure all method names and signatures are correct. Your methods cannot have a return value.\r\n *\r\n * Then, call `MyNotificationHandler.register` at startup to connect your class to your channel.\r\n * @public\r\n */\r\nexport abstract class NotificationHandler {\r\n  /** All subclasses must implement this method to specify their response channel name. */\r\n  public abstract get channelName(): string;\r\n\r\n  public registerImpl(): RemoveFunction {\r\n    return IpcApp.addListener(this.channelName, (_evt: Event, funcName: string, ...args: any[]) => {\r\n      const func = (this as any)[funcName];\r\n      if (typeof func !== \"function\")\r\n        throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${this.constructor.name}.${funcName}\" not found on NotificationHandler registered for channel: ${this.channelName}`);\r\n\r\n      func.call(this, ...args);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Register this class as the handler for notifications on its channel. This static method creates a new instance\r\n   * that becomes the notification handler and is `this` when its methods are called.\r\n   * @returns A function that can be called to remove the handler.\r\n   * @note this method should only be called once per channel. If it is called multiple times, multiple handlers are established.\r\n   */\r\n  public static register(): RemoveFunction {\r\n    return (new (this as any)() as NotificationHandler).registerImpl(); // create an instance of subclass. \"as any\" is necessary because base class is abstract\r\n  }\r\n}\r\n\r\n/** IpcApp notifications from backend */\r\nclass IpcAppNotifyHandler extends NotificationHandler implements IpcAppNotifications {\r\n  public get channelName() { return IpcAppChannel.AppNotify; }\r\n  public notifyApp() { }\r\n}\r\n"]}
+{"version":3,"file":"IpcApp.js","sourceRoot":"","sources":["../../src/IpcApp.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EACL,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EACtD,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAoB,MAAM,aAAa,CAAC;AAU1D;;;GAGG;AACH,MAAM,OAAO,MAAM;IAEjB,qEAAqE;IAE7D,MAAM,KAAK,GAAG,KAAwB,OAAO,IAAI,CAAC,IAAK,CAAC,CAAC,CAAC;IAElE,iIAAiI;IAC1H,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,OAAe,EAAE,OAAoB;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,OAAe,EAAE,QAAqB;QACjE,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,GAAG,IAAW;QACxD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAmB,EAAE,UAAkB,EAAE,GAAG,IAAW;QACxF,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,CAAoB,CAAC;QACxF,IAAI,SAAS,KAAK,MAAM,CAAC,KAAK,EAAE;YAC9B,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChG,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC/B,MAAM,GAAG,CAAC;SACX;QACD,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,WAAW,CAA4C,UAAa,EAAE,GAAG,IAAoC;QAC/H,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAA0C,CAAC;IACpH,CAAC;IAED;qFACiF;IAC1E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAsB,EAAE,IAAoB;QACtE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC,sCAAsC;QACtE,MAAM,SAAS,CAAC,OAAO,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAgB,mBAAmB;IAIhC,YAAY;QACjB,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAW,EAAE,QAAgB,EAAE,GAAG,IAAW,EAAE,EAAE;YAC5F,MAAM,IAAI,GAAI,IAAY,CAAC,QAAQ,CAAC,CAAC;YACrC,IAAI,OAAO,IAAI,KAAK,UAAU;gBAC5B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,WAAW,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,8DAA8D,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAErL,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ;QACpB,OAAQ,IAAK,IAAY,EAA0B,CAAC,YAAY,EAAE,CAAC,CAAC,uFAAuF;IAC7J,CAAC;CACF;AAED,wCAAwC;AACxC,MAAM,mBAAoB,SAAQ,mBAAmB;IACnD,IAAW,WAAW,KAAK,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,SAAS,KAAK,CAAC;CACvB","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 NativeApp\r\n */\r\n\r\nimport { AsyncMethodsOf, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport {\r\n  BackendError, IModelError, IModelStatus, IpcAppChannel, IpcAppFunctions, IpcAppNotifications, IpcInvokeReturn, IpcListener, IpcSocketFrontend,\r\n  iTwinChannel, RemoveFunction,\r\n} from \"@itwin/core-common\";\r\nimport { IModelApp, IModelAppOptions } from \"./IModelApp\";\r\n\r\n/**\r\n * Options for [[IpcApp.startup]]\r\n * @public\r\n */\r\nexport interface IpcAppOptions {\r\n  iModelApp?: IModelAppOptions;\r\n}\r\n\r\n/**\r\n * The frontend of apps with a dedicated backend that can use [Ipc]($docs/learning/IpcInterface.md).\r\n * @public\r\n */\r\nexport class IpcApp {\r\n  private static _ipc: IpcSocketFrontend | undefined;\r\n  /** Get the implementation of the [[IpcSocketFrontend]] interface. */\r\n\r\n  private static get ipc(): IpcSocketFrontend { return this._ipc!; }\r\n\r\n  /** Determine whether Ipc is available for this frontend. This will only be true if [[startup]] has been called on this class. */\r\n  public static get isValid(): boolean { return undefined !== this._ipc; }\r\n\r\n  /**\r\n   * Establish a message handler function for the supplied channel over Ipc. The handler will be called when messages are sent for\r\n   * the channel via  [[BackendIpc.send]].\r\n   * @param channel the name of the channel\r\n   * @param handler the message handler\r\n   * @returns A function to remove the handler\r\n   * @note Ipc is only supported if [[isValid]] is true.\r\n   */\r\n  public static addListener(channel: string, handler: IpcListener): RemoveFunction {\r\n    return this.ipc.addListener(iTwinChannel(channel), handler);\r\n  }\r\n\r\n  /**\r\n   * Remove a previously registered listener\r\n   * @param channel The name of the channel for the listener previously registered with [[addListener]]\r\n   * @param listener The function passed to [[addListener]]\r\n   */\r\n  public static removeListener(channel: string, listener: IpcListener) {\r\n    this.ipc.removeListener(iTwinChannel(channel), listener);\r\n  }\r\n\r\n  /**\r\n   * Send a message to the backend via `channel` and expect a result asynchronously. The handler must be established on the backend via [[BackendIpc.handle]]\r\n   * @param channel The name of the channel for the method.\r\n   * @see Electron [ipcRenderer.invoke](https://www.electronjs.org/docs/api/ipc-renderer) documentation for details.\r\n   * Note that this interface may be implemented via Electron for desktop apps, or via\r\n   * [WebSockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) for mobile or web-based\r\n   * Ipc connections. In either case, the Electron documentation provides the specifications for how it works.\r\n   * @note `args` are serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  public static async invoke(channel: string, ...args: any[]): Promise<any> {\r\n    return this.ipc.invoke(iTwinChannel(channel), ...args);\r\n  }\r\n\r\n  /**\r\n   * Send a message over the socket.\r\n   * @param channel The name of the channel for the message.\r\n   * @param data The optional data of the message.\r\n   * @note `data` is serialized with the [Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm), so only\r\n   * primitive types and `ArrayBuffers` are allowed.\r\n   */\r\n  public static send(channel: string, ...data: any[]) {\r\n    return this.ipc.send(iTwinChannel(channel), ...data);\r\n  }\r\n\r\n  /**\r\n   * Call a method on the backend through an Ipc channel.\r\n   * @param channelName the channel registered by the backend handler.\r\n   * @param methodName  the name of a method implemented by the backend handler.\r\n   * @param args arguments to `methodName`\r\n   * @return a Promise with the return value from `methodName`\r\n   * @note If the backend implementation throws an exception, this method will throw a [[BackendError]] exception\r\n   * with the `errorNumber` and `message` from the backend.\r\n   * @note Ipc is only supported if [[isValid]] is true.\r\n   * @internal\r\n   */\r\n  public static async callIpcChannel(channelName: string, methodName: string, ...args: any[]): Promise<any> {\r\n    const retVal = (await this.invoke(channelName, methodName, ...args)) as IpcInvokeReturn;\r\n    if (undefined !== retVal.error) {\r\n      const err = new BackendError(retVal.error.errorNumber, retVal.error.name, retVal.error.message);\r\n      err.stack = retVal.error.stack;\r\n      throw err;\r\n    }\r\n    return retVal.result;\r\n  }\r\n\r\n  public static async callIpcHost<T extends AsyncMethodsOf<IpcAppFunctions>>(methodName: T, ...args: Parameters<IpcAppFunctions[T]>) {\r\n    return this.callIpcChannel(IpcAppChannel.Functions, methodName, ...args) as PromiseReturnType<IpcAppFunctions[T]>;\r\n  }\r\n\r\n  /** start an IpcApp.\r\n   * @note this should not be called directly. It is called by NativeApp.startup */\r\n  public static async startup(ipc: IpcSocketFrontend, opts?: IpcAppOptions) {\r\n    this._ipc = ipc;\r\n    IpcAppNotifyHandler.register(); // receives notifications from backend\r\n    await IModelApp.startup(opts?.iModelApp);\r\n  }\r\n\r\n  /** @internal */\r\n  public static async shutdown() {\r\n    this._ipc = undefined;\r\n    await IModelApp.shutdown();\r\n  }\r\n}\r\n\r\n/**\r\n * Base class for all implementations of an Ipc notification response interface. This class is implemented on your frontend to supply\r\n * methods to receive notifications from your backend.\r\n *\r\n * Create a subclass to implement your Ipc response interface. Your class should be declared like this:\r\n * ```ts\r\n * class MyNotificationHandler extends NotificationHandler implements MyNotifications\r\n * ```\r\n * to ensure all method names and signatures are correct. Your methods cannot have a return value.\r\n *\r\n * Then, call `MyNotificationHandler.register` at startup to connect your class to your channel.\r\n * @public\r\n * @extensions\r\n */\r\nexport abstract class NotificationHandler {\r\n  /** All subclasses must implement this method to specify their response channel name. */\r\n  public abstract get channelName(): string;\r\n\r\n  public registerImpl(): RemoveFunction {\r\n    return IpcApp.addListener(this.channelName, (_evt: Event, funcName: string, ...args: any[]) => {\r\n      const func = (this as any)[funcName];\r\n      if (typeof func !== \"function\")\r\n        throw new IModelError(IModelStatus.FunctionNotFound, `Method \"${this.constructor.name}.${funcName}\" not found on NotificationHandler registered for channel: ${this.channelName}`);\r\n\r\n      func.call(this, ...args);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Register this class as the handler for notifications on its channel. This static method creates a new instance\r\n   * that becomes the notification handler and is `this` when its methods are called.\r\n   * @returns A function that can be called to remove the handler.\r\n   * @note this method should only be called once per channel. If it is called multiple times, multiple handlers are established.\r\n   */\r\n  public static register(): RemoveFunction {\r\n    return (new (this as any)() as NotificationHandler).registerImpl(); // create an instance of subclass. \"as any\" is necessary because base class is abstract\r\n  }\r\n}\r\n\r\n/** IpcApp notifications from backend */\r\nclass IpcAppNotifyHandler extends NotificationHandler implements IpcAppNotifications {\r\n  public get channelName() { return IpcAppChannel.AppNotify; }\r\n  public notifyApp() { }\r\n}\r\n"]}

package/lib/esm/MarginPercent.d.ts

@@ -4,6 +4,7 @@
 /** Margins for white space to be left around view volumes for [[ViewState.lookAtVolume]].
  * Values mean "fraction of view size" and must be between 0 and .25.
  * @public
+ * @extensions
  */
 export declare class MarginPercent {
     left: number;

package/lib/esm/MarginPercent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MarginPercent.d.ts","sourceRoot":"","sources":["../../src/MarginPercent.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH;;;GAGG;AACH,qBAAa,aAAa;IACL,IAAI,EAAE,MAAM;IAAS,GAAG,EAAE,MAAM;IAAS,KAAK,EAAE,MAAM;IAAS,MAAM,EAAE,MAAM;gBAA7E,IAAI,EAAE,MAAM,EAAS,GAAG,EAAE,MAAM,EAAS,KAAK,EAAE,MAAM,EAAS,MAAM,EAAE,MAAM;CAOjG"}
+{"version":3,"file":"MarginPercent.d.ts","sourceRoot":"","sources":["../../src/MarginPercent.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH;;;;GAIG;AACH,qBAAa,aAAa;IACL,IAAI,EAAE,MAAM;IAAS,GAAG,EAAE,MAAM;IAAS,KAAK,EAAE,MAAM;IAAS,MAAM,EAAE,MAAM;gBAA7E,IAAI,EAAE,MAAM,EAAS,GAAG,EAAE,MAAM,EAAS,KAAK,EAAE,MAAM,EAAS,MAAM,EAAE,MAAM;CAOjG"}

package/lib/esm/MarginPercent.js

@@ -9,6 +9,7 @@ import { Geometry } from "@itwin/core-geometry";
 /** Margins for white space to be left around view volumes for [[ViewState.lookAtVolume]].
  * Values mean "fraction of view size" and must be between 0 and .25.
  * @public
+ * @extensions
  */
 export class MarginPercent {
     constructor(left, top, right, bottom) {

package/lib/esm/MarginPercent.js.map

@@ -1 +1 @@
-{"version":3,"file":"MarginPercent.js","sourceRoot":"","sources":["../../src/MarginPercent.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD;;;GAGG;AACH,MAAM,OAAO,aAAa;IACxB,YAAmB,IAAY,EAAS,GAAW,EAAS,KAAa,EAAS,MAAc;QAA7E,SAAI,GAAJ,IAAI,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAQ;QAAS,WAAM,GAAN,MAAM,CAAQ;QAC9F,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;CACF","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 Views\r\n */\r\n\r\nimport { Geometry } from \"@itwin/core-geometry\";\r\n/** Margins for white space to be left around view volumes for [[ViewState.lookAtVolume]].\r\n * Values mean \"fraction of view size\" and must be between 0 and .25.\r\n * @public\r\n */\r\nexport class MarginPercent {\r\n  constructor(public left: number, public top: number, public right: number, public bottom: number) {\r\n    const limitMargin = (val: number) => Geometry.clamp(val, 0.0, 0.25);\r\n    this.left = limitMargin(left);\r\n    this.top = limitMargin(top);\r\n    this.right = limitMargin(right);\r\n    this.bottom = limitMargin(bottom);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MarginPercent.js","sourceRoot":"","sources":["../../src/MarginPercent.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD;;;;GAIG;AACH,MAAM,OAAO,aAAa;IACxB,YAAmB,IAAY,EAAS,GAAW,EAAS,KAAa,EAAS,MAAc;QAA7E,SAAI,GAAJ,IAAI,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAQ;QAAS,WAAM,GAAN,MAAM,CAAQ;QAC9F,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;CACF","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 Views\r\n */\r\n\r\nimport { Geometry } from \"@itwin/core-geometry\";\r\n/** Margins for white space to be left around view volumes for [[ViewState.lookAtVolume]].\r\n * Values mean \"fraction of view size\" and must be between 0 and .25.\r\n * @public\r\n * @extensions\r\n */\r\nexport class MarginPercent {\r\n  constructor(public left: number, public top: number, public right: number, public bottom: number) {\r\n    const limitMargin = (val: number) => Geometry.clamp(val, 0.0, 0.25);\r\n    this.left = limitMargin(left);\r\n    this.top = limitMargin(top);\r\n    this.right = limitMargin(right);\r\n    this.bottom = limitMargin(bottom);\r\n  }\r\n}\r\n"]}

package/lib/esm/Marker.d.ts

@@ -11,18 +11,29 @@ import { ScreenViewport, Viewport } from "./Viewport";
 import { ViewRect } from "./ViewRect";
 /** The types that may be used for Markers
  * @public
+ * @extensions
  */
 export declare type MarkerImage = HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageBitmap;
-/** @public */
+/**
+ * @public
+ * @extensions
+ */
 export declare type MarkerFillStyle = string | CanvasGradient | CanvasPattern;
-/** @public */
+/**
+ * @public
+ * @extensions
+ */
 export declare type MarkerTextAlign = "left" | "right" | "center" | "start" | "end";
-/** @public */
+/**
+ * @public
+ * @extensions
+ */
 export declare type MarkerTextBaseline = "top" | "hanging" | "middle" | "alphabetic" | "ideographic" | "bottom";
 /** A Marker is a [[CanvasDecoration]], whose position follows a fixed location in world space.
  * Markers draw on top of all scene graphics, and show visual cues about locations of interest.
  * @see [Markers]($docs/learning/frontend/Markers)
  * @public
+ * @extensions
  */
 export declare class Marker implements CanvasDecoration {
     protected _scaleFactor?: Point2d;
@@ -139,6 +150,7 @@ export declare class Marker implements CanvasDecoration {
 /** A cluster of one or more Markers that overlap one another in the view. The cluster's screen position is taken from its first entry.
  * Clusters also have a Marker themselves, that represents the whole group. The cluster marker isn't created until all entries have been added.
  * @public
+ * @extensions
  */
 export declare class Cluster<T extends Marker> {
     readonly markers: T[];
@@ -154,6 +166,7 @@ export declare class Cluster<T extends Marker> {
 /** A *set* of Markers that are logically related, such that they *cluster* when they overlap one another in screen space.
  * In that case, a *cluster marker* is drawn instead of the overlapping Markers.
  * @public
+ * @extensions
  */
 export declare abstract class MarkerSet<T extends Marker> {
     private _viewport?;

package/lib/esm/Marker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Marker.d.ts","sourceRoot":"","sources":["../../src/Marker.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAY,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAY,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC5H,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAI9C,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;GAEG;AACH,oBAAY,WAAW,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,WAAW,CAAC;AAEhG,cAAc;AACd,oBAAY,eAAe,GAAG,MAAM,GAAG,cAAc,GAAG,aAAa,CAAC;AAEtE,cAAc;AACd,oBAAY,eAAe,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAC;AAE5E,cAAc;AACd,oBAAY,kBAAkB,GAAG,KAAK,GAAG,SAAS,GAAG,QAAQ,GAAG,YAAY,GAAG,aAAa,GAAG,QAAQ,CAAC;AAoBxG;;;;GAIG;AACH,qBAAa,MAAO,YAAW,gBAAgB;IAC7C,SAAS,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IACjC,SAAS,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAEtC,wFAAwF;IACjF,OAAO,UAAQ;IACtB,uDAAuD;IACvD,SAAS,CAAC,UAAU,UAAS;IAC7B,+DAA+D;IAC/D,SAAS,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;IAClC,wDAAwD;IACjD,aAAa,EAAE,OAAO,CAAC;IAC9B,0CAA0C;IACnC,IAAI,EAAE,OAAO,CAAC;IACrB,iIAAiI;IAC1H,QAAQ,UAAiB;IAChC,kIAAkI;IAClI,SAAgB,IAAI,WAAkB;IACtC,mKAAmK;IAC5J,KAAK,CAAC,EAAE,WAAW,CAAC;IAC3B,kGAAkG;IAC3F,WAAW,CAAC,EAAE,KAAK,CAAC;IAC3B,oEAAoE;IAC7D,SAAS,CAAC,EAAE,KAAK,CAAC;IACzB,yEAAyE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;IACtB,kGAAkG;IAC3F,WAAW,CAAC,EAAE,KAAK,CAAC;IAC3B,sHAAsH;IAC/G,aAAa,CAAC,EAAE,MAAM,CAAC;IAC9B,gJAAgJ;IACzI,UAAU,CAAC,EAAE,eAAe,CAAC;IACpC,wJAAwJ;IACjJ,UAAU,CAAC,EAAE,eAAe,CAAC;IACpC,0JAA0J;IACnJ,aAAa,CAAC,EAAE,kBAAkB,CAAC;IAC1C,kHAAkH;IAC3G,SAAS,CAAC,EAAE,MAAM,CAAC;IAC1B,oJAAoJ;IAC7I,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IACpC,+CAA+C;IACxC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEvC;;;;;;OAMG;IACI,WAAW,CAAC,EAAE,WAAW,CAAC;IAEjC,oDAAoD;IACpD,IAAW,SAAS,YAAmB;IAEvC,yJAAyJ;IAClJ,QAAQ,CAAC,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;IAErD,wDAAwD;IACjD,YAAY,CAAC,EAAE,EAAE,aAAa;IAErC,wDAAwD;IACjD,YAAY;IAEnB,2DAA2D;IACpD,WAAW,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI;IAI3C,8DAA8D;IACvD,aAAa,CAAC,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;IAElD,0DAA0D;IACnD,IAAI,CAAC,EAAE,EAAE,KAAK,GAAG,OAAO;IAE/B;;;;OAIG;IACI,cAAc,CAAC,KAAK,EAAE,YAAY;IAKzC;;;OAGG;gBACS,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK;IAK9C;;OAEG;WACW,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC;IAU1E;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,wBAAwB;IAOnD,sFAAsF;IAC/E,cAAc,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;IA8B1D;;;OAGG;IACI,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAczD,gDAAgD;IACzC,WAAW,CAAC,GAAG,EAAE,MAAM;IAE9B;;;OAGG;IACI,WAAW,CAAC,EAAE,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,OAAO;IAmCxE;;;OAGG;IACH,SAAS,CAAC,YAAY;IAUtB,uDAAuD;IAChD,SAAS,CAAC,OAAO,EAAE,eAAe;IASzC;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,eAAe;CAI9C;AAED;;;GAGG;AACH,qBAAa,OAAO,CAAC,CAAC,SAAS,MAAM;IACnC,SAAgB,OAAO,EAAE,CAAC,EAAE,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;gBAEX,OAAO,EAAE,CAAC,EAAE;IAK/B,IAAW,QAAQ,YAElB;IAED;;;OAGG;IACI,kBAAkB;CAQ1B;AAED;;;GAGG;AACH,8BAAsB,SAAS,CAAC,CAAC,SAAS,MAAM;IAC9C,OAAO,CAAC,SAAS,CAAC,CAAiB;IAEnC,gBAAgB;IAChB,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAM;IAC/C,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,eAAe,WAAyB;IAC3D,gBAAgB;IAChB,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IAEnD,qKAAqK;IAC9J,kBAAkB,SAAK;IAC9B,4EAA4E;IAC5E,IAAW,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAA0B;IACtD,+OAA+O;IAC/O,SAAS,CAAC,aAAa,SAAK;IAE5B;;OAEG;gBACgB,QAAQ,CAAC,EAAE,cAAc;IAQ5C,4CAA4C;IAC5C,IAAW,QAAQ,IAAI,cAAc,GAAG,SAAS,CAA2B;IAE5E;;;OAGG;IACI,cAAc,CAAC,QAAQ,EAAE,cAAc;IAK9C;;;;;;OAMG;IACI,SAAS,IAAI,IAAI;IAIxB;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM;IAEhE,sGAAsG;IAC/F,gBAAgB,CAAC,EAAE,EAAE,QAAQ,GAAG,MAAM;IAM7C;;;OAGG;IACI,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;CAmErD"}
+{"version":3,"file":"Marker.d.ts","sourceRoot":"","sources":["../../src/Marker.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAY,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAY,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC5H,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAI9C,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,oBAAY,WAAW,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,WAAW,CAAC;AAEhG;;;GAGG;AACH,oBAAY,eAAe,GAAG,MAAM,GAAG,cAAc,GAAG,aAAa,CAAC;AAEtE;;;GAGG;AACH,oBAAY,eAAe,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAC;AAE5E;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,KAAK,GAAG,SAAS,GAAG,QAAQ,GAAG,YAAY,GAAG,aAAa,GAAG,QAAQ,CAAC;AAoBxG;;;;;GAKG;AACH,qBAAa,MAAO,YAAW,gBAAgB;IAC7C,SAAS,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IACjC,SAAS,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAEtC,wFAAwF;IACjF,OAAO,UAAQ;IACtB,uDAAuD;IACvD,SAAS,CAAC,UAAU,UAAS;IAC7B,+DAA+D;IAC/D,SAAS,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC;IAClC,wDAAwD;IACjD,aAAa,EAAE,OAAO,CAAC;IAC9B,0CAA0C;IACnC,IAAI,EAAE,OAAO,CAAC;IACrB,iIAAiI;IAC1H,QAAQ,UAAiB;IAChC,kIAAkI;IAClI,SAAgB,IAAI,WAAkB;IACtC,mKAAmK;IAC5J,KAAK,CAAC,EAAE,WAAW,CAAC;IAC3B,kGAAkG;IAC3F,WAAW,CAAC,EAAE,KAAK,CAAC;IAC3B,oEAAoE;IAC7D,SAAS,CAAC,EAAE,KAAK,CAAC;IACzB,yEAAyE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;IACtB,kGAAkG;IAC3F,WAAW,CAAC,EAAE,KAAK,CAAC;IAC3B,sHAAsH;IAC/G,aAAa,CAAC,EAAE,MAAM,CAAC;IAC9B,gJAAgJ;IACzI,UAAU,CAAC,EAAE,eAAe,CAAC;IACpC,wJAAwJ;IACjJ,UAAU,CAAC,EAAE,eAAe,CAAC;IACpC,0JAA0J;IACnJ,aAAa,CAAC,EAAE,kBAAkB,CAAC;IAC1C,kHAAkH;IAC3G,SAAS,CAAC,EAAE,MAAM,CAAC;IAC1B,oJAAoJ;IAC7I,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IACpC,+CAA+C;IACxC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEvC;;;;;;OAMG;IACI,WAAW,CAAC,EAAE,WAAW,CAAC;IAEjC,oDAAoD;IACpD,IAAW,SAAS,YAAmB;IAEvC,yJAAyJ;IAClJ,QAAQ,CAAC,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;IAErD,wDAAwD;IACjD,YAAY,CAAC,EAAE,EAAE,aAAa;IAErC,wDAAwD;IACjD,YAAY;IAEnB,2DAA2D;IACpD,WAAW,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI;IAI3C,8DAA8D;IACvD,aAAa,CAAC,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;IAElD,0DAA0D;IACnD,IAAI,CAAC,EAAE,EAAE,KAAK,GAAG,OAAO;IAE/B;;;;OAIG;IACI,cAAc,CAAC,KAAK,EAAE,YAAY;IAKzC;;;OAGG;gBACS,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK;IAK9C;;OAEG;WACW,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC;IAU1E;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,wBAAwB;IAOnD,sFAAsF;IAC/E,cAAc,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;IA8B1D;;;OAGG;IACI,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAczD,gDAAgD;IACzC,WAAW,CAAC,GAAG,EAAE,MAAM;IAE9B;;;OAGG;IACI,WAAW,CAAC,EAAE,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,OAAO;IAmCxE;;;OAGG;IACH,SAAS,CAAC,YAAY;IAUtB,uDAAuD;IAChD,SAAS,CAAC,OAAO,EAAE,eAAe;IASzC;;;;OAIG;IACI,aAAa,CAAC,OAAO,EAAE,eAAe;CAI9C;AAED;;;;GAIG;AACH,qBAAa,OAAO,CAAC,CAAC,SAAS,MAAM;IACnC,SAAgB,OAAO,EAAE,CAAC,EAAE,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;gBAEX,OAAO,EAAE,CAAC,EAAE;IAK/B,IAAW,QAAQ,YAElB;IAED;;;OAGG;IACI,kBAAkB;CAQ1B;AAED;;;;GAIG;AACH,8BAAsB,SAAS,CAAC,CAAC,SAAS,MAAM;IAC9C,OAAO,CAAC,SAAS,CAAC,CAAiB;IAEnC,gBAAgB;IAChB,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAM;IAC/C,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,eAAe,WAAyB;IAC3D,gBAAgB;IAChB,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IAEnD,qKAAqK;IAC9J,kBAAkB,SAAK;IAC9B,4EAA4E;IAC5E,IAAW,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAA0B;IACtD,+OAA+O;IAC/O,SAAS,CAAC,aAAa,SAAK;IAE5B;;OAEG;gBACgB,QAAQ,CAAC,EAAE,cAAc;IAQ5C,4CAA4C;IAC5C,IAAW,QAAQ,IAAI,cAAc,GAAG,SAAS,CAA2B;IAE5E;;;OAGG;IACI,cAAc,CAAC,QAAQ,EAAE,cAAc;IAK9C;;;;;;OAMG;IACI,SAAS,IAAI,IAAI;IAIxB;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM;IAEhE,sGAAsG;IAC/F,gBAAgB,CAAC,EAAE,EAAE,QAAQ,GAAG,MAAM;IAM7C;;;OAGG;IACI,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;CAmErD"}

package/lib/esm/Marker.js

@@ -33,6 +33,7 @@ function getMinScaleViewW(vp) {
  * Markers draw on top of all scene graphics, and show visual cues about locations of interest.
  * @see [Markers]($docs/learning/frontend/Markers)
  * @public
+ * @extensions
  */
 export class Marker {
     /** Constructor for Marker
@@ -208,6 +209,7 @@ export class Marker {
 /** A cluster of one or more Markers that overlap one another in the view. The cluster's screen position is taken from its first entry.
  * Clusters also have a Marker themselves, that represents the whole group. The cluster marker isn't created until all entries have been added.
  * @public
+ * @extensions
  */
 export class Cluster {
     constructor(markers) {
@@ -233,6 +235,7 @@ export class Cluster {
 /** A *set* of Markers that are logically related, such that they *cluster* when they overlap one another in screen space.
  * In that case, a *cluster marker* is drawn instead of the overlapping Markers.
  * @public
+ * @extensions
  */
 export class MarkerSet {
     /** Construct a new MarkerSet for a specific ScreenViewport.