@itwin/core-common 3.0.0-dev.172 → 3.0.0-dev.176

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/lib/cjs/TextureProps.d.ts

@@ -28,6 +28,23 @@ export interface TextureLoadProps {
     /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */
     maxTextureSize?: number;
 }
+/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).
+ * Each pixel can be classified as either opaque or translucent.
+ * The transparency of the image as a whole is based on the combination of pixel transparencies.
+ * If this information is known, it should be supplied when creating a texture for more efficient rendering.
+ * @see [TextureImage.transparency]($frontend).
+ * @public
+ */
+export declare enum TextureTransparency {
+    /** The image contains only opaque pixels. It should not blend with other objects in the scene. */
+    Opaque = 0,
+    /** The image contains only translucent pixels. It should blend with other objects in the scene. */
+    Translucent = 1,
+    /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while
+     * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.
+     */
+    Mixed = 2
+}
 /** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].
  * @public
  */
@@ -36,9 +53,11 @@ export interface TextureData {
     width: number;
     /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */
     height: number;
-    /** The format of the returned data, Jpeg or Png. */
+    /** The format of the image (Jpeg or Png). */
     format: ImageSourceFormat;
-    /** returned byte data */
+    /** The encoded image bytes. */
     bytes: Uint8Array;
+    /** Information about the transparency of the texture image. Default: [[TextureTransparency.Mixed]]. */
+    transparency?: TextureTransparency;
 }
 //# sourceMappingURL=TextureProps.d.ts.map

package/lib/cjs/TextureProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextureProps.d.ts","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,sBAAsB;IAC1D,gCAAgC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;;OAGG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAC1B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,iJAAiJ;IACjJ,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qHAAqH;IACrH,KAAK,EAAE,MAAM,CAAC;IACd,uHAAuH;IACvH,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,yBAAyB;IACzB,KAAK,EAAE,UAAU,CAAC;CACnB"}
+{"version":3,"file":"TextureProps.d.ts","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,sBAAsB;IAC1D,gCAAgC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;;OAGG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAC1B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,iJAAiJ;IACjJ,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;GAMG;AACH,oBAAY,mBAAmB;IAC7B,kGAAkG;IAClG,MAAM,IAAA;IACN,mGAAmG;IACnG,WAAW,IAAA;IACX;;OAEG;IACH,KAAK,IAAA;CACN;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qHAAqH;IACrH,KAAK,EAAE,MAAM,CAAC;IACd,uHAAuH;IACvH,MAAM,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,MAAM,EAAE,iBAAiB,CAAC;IAC1B,+BAA+B;IAC/B,KAAK,EAAE,UAAU,CAAC;IAClB,uGAAuG;IACvG,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC"}

package/lib/cjs/TextureProps.js

@@ -7,4 +7,23 @@
  * @module Entities
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextureTransparency = void 0;
+/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).
+ * Each pixel can be classified as either opaque or translucent.
+ * The transparency of the image as a whole is based on the combination of pixel transparencies.
+ * If this information is known, it should be supplied when creating a texture for more efficient rendering.
+ * @see [TextureImage.transparency]($frontend).
+ * @public
+ */
+var TextureTransparency;
+(function (TextureTransparency) {
+    /** The image contains only opaque pixels. It should not blend with other objects in the scene. */
+    TextureTransparency[TextureTransparency["Opaque"] = 0] = "Opaque";
+    /** The image contains only translucent pixels. It should blend with other objects in the scene. */
+    TextureTransparency[TextureTransparency["Translucent"] = 1] = "Translucent";
+    /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while
+     * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.
+     */
+    TextureTransparency[TextureTransparency["Mixed"] = 2] = "Mixed";
+})(TextureTransparency = exports.TextureTransparency || (exports.TextureTransparency = {}));
 //# sourceMappingURL=TextureProps.js.map

package/lib/cjs/TextureProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextureProps.js","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Entities\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { ImageSourceFormat } from \"./Image\";\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\n\r\n/** Properties that define a [Texture]($backend) element.\r\n * @public\r\n */\r\nexport interface TextureProps extends DefinitionElementProps {\r\n  /** Format of the image data. */\r\n  format: ImageSourceFormat;\r\n  /** The image data stored in a Base64-encoded string according to the specified format.\r\n   * @see [[Base64EncodedString.fromUint8Array]] to produce a well-formed base-64-encoded string.\r\n   * @see [[Base64EncodedString.toUint8Array]] to decode the bytes.\r\n   */\r\n  data: Base64EncodedString;\r\n  /** An optional description of the texture. */\r\n  description?: string;\r\n}\r\n\r\n/** Properties that specify what texture should be loaded and how it should be loaded.\r\n * @public\r\n */\r\nexport interface TextureLoadProps {\r\n  /** A valid Id64 string identifying the texture */\r\n  name: Id64String;\r\n  /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */\r\n  maxTextureSize?: number;\r\n}\r\n\r\n/** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].\r\n * @public\r\n */\r\nexport interface TextureData {\r\n  /** The width of the image, possibly reduced from the original width based on [[TextureLoadProps.maxTextureSize]]. */\r\n  width: number;\r\n  /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */\r\n  height: number;\r\n  /** The format of the returned data, Jpeg or Png. */\r\n  format: ImageSourceFormat;\r\n  /** returned byte data */\r\n  bytes: Uint8Array;\r\n}\r\n"]}
+{"version":3,"file":"TextureProps.js","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAgCH;;;;;;GAMG;AACH,IAAY,mBASX;AATD,WAAY,mBAAmB;IAC7B,kGAAkG;IAClG,iEAAM,CAAA;IACN,mGAAmG;IACnG,2EAAW,CAAA;IACX;;OAEG;IACH,+DAAK,CAAA;AACP,CAAC,EATW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAS9B","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 Entities\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { ImageSourceFormat } from \"./Image\";\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\n\r\n/** Properties that define a [Texture]($backend) element.\r\n * @public\r\n */\r\nexport interface TextureProps extends DefinitionElementProps {\r\n  /** Format of the image data. */\r\n  format: ImageSourceFormat;\r\n  /** The image data stored in a Base64-encoded string according to the specified format.\r\n   * @see [[Base64EncodedString.fromUint8Array]] to produce a well-formed base-64-encoded string.\r\n   * @see [[Base64EncodedString.toUint8Array]] to decode the bytes.\r\n   */\r\n  data: Base64EncodedString;\r\n  /** An optional description of the texture. */\r\n  description?: string;\r\n}\r\n\r\n/** Properties that specify what texture should be loaded and how it should be loaded.\r\n * @public\r\n */\r\nexport interface TextureLoadProps {\r\n  /** A valid Id64 string identifying the texture */\r\n  name: Id64String;\r\n  /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */\r\n  maxTextureSize?: number;\r\n}\r\n\r\n/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).\r\n * Each pixel can be classified as either opaque or translucent.\r\n * The transparency of the image as a whole is based on the combination of pixel transparencies.\r\n * If this information is known, it should be supplied when creating a texture for more efficient rendering.\r\n * @see [TextureImage.transparency]($frontend).\r\n * @public\r\n */\r\nexport enum TextureTransparency {\r\n  /** The image contains only opaque pixels. It should not blend with other objects in the scene. */\r\n  Opaque,\r\n  /** The image contains only translucent pixels. It should blend with other objects in the scene. */\r\n  Translucent,\r\n  /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while\r\n   * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.\r\n   */\r\n  Mixed,\r\n}\r\n\r\n/** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].\r\n * @public\r\n */\r\nexport interface TextureData {\r\n  /** The width of the image, possibly reduced from the original width based on [[TextureLoadProps.maxTextureSize]]. */\r\n  width: number;\r\n  /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */\r\n  height: number;\r\n  /** The format of the image (Jpeg or Png). */\r\n  format: ImageSourceFormat;\r\n  /** The encoded image bytes. */\r\n  bytes: Uint8Array;\r\n  /** Information about the transparency of the texture image. Default: [[TextureTransparency.Mixed]]. */\r\n  transparency?: TextureTransparency;\r\n}\r\n"]}

package/lib/esm/TextureProps.d.ts

@@ -28,6 +28,23 @@ export interface TextureLoadProps {
     /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */
     maxTextureSize?: number;
 }
+/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).
+ * Each pixel can be classified as either opaque or translucent.
+ * The transparency of the image as a whole is based on the combination of pixel transparencies.
+ * If this information is known, it should be supplied when creating a texture for more efficient rendering.
+ * @see [TextureImage.transparency]($frontend).
+ * @public
+ */
+export declare enum TextureTransparency {
+    /** The image contains only opaque pixels. It should not blend with other objects in the scene. */
+    Opaque = 0,
+    /** The image contains only translucent pixels. It should blend with other objects in the scene. */
+    Translucent = 1,
+    /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while
+     * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.
+     */
+    Mixed = 2
+}
 /** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].
  * @public
  */
@@ -36,9 +53,11 @@ export interface TextureData {
     width: number;
     /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */
     height: number;
-    /** The format of the returned data, Jpeg or Png. */
+    /** The format of the image (Jpeg or Png). */
     format: ImageSourceFormat;
-    /** returned byte data */
+    /** The encoded image bytes. */
     bytes: Uint8Array;
+    /** Information about the transparency of the texture image. Default: [[TextureTransparency.Mixed]]. */
+    transparency?: TextureTransparency;
 }
 //# sourceMappingURL=TextureProps.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"TextureProps.d.ts","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,sBAAsB;IAC1D,gCAAgC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;;OAGG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAC1B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,iJAAiJ;IACjJ,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qHAAqH;IACrH,KAAK,EAAE,MAAM,CAAC;IACd,uHAAuH;IACvH,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,MAAM,EAAE,iBAAiB,CAAC;IAC1B,yBAAyB;IACzB,KAAK,EAAE,UAAU,CAAC;CACnB"}
+{"version":3,"file":"TextureProps.d.ts","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,sBAAsB;IAC1D,gCAAgC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;;OAGG;IACH,IAAI,EAAE,mBAAmB,CAAC;IAC1B,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,iJAAiJ;IACjJ,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;GAMG;AACH,oBAAY,mBAAmB;IAC7B,kGAAkG;IAClG,MAAM,IAAA;IACN,mGAAmG;IACnG,WAAW,IAAA;IACX;;OAEG;IACH,KAAK,IAAA;CACN;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qHAAqH;IACrH,KAAK,EAAE,MAAM,CAAC;IACd,uHAAuH;IACvH,MAAM,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,MAAM,EAAE,iBAAiB,CAAC;IAC1B,+BAA+B;IAC/B,KAAK,EAAE,UAAU,CAAC;IAClB,uGAAuG;IACvG,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC"}

package/lib/esm/TextureProps.js

@@ -5,5 +5,22 @@
 /** @packageDocumentation
  * @module Entities
  */
-export {};
+/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).
+ * Each pixel can be classified as either opaque or translucent.
+ * The transparency of the image as a whole is based on the combination of pixel transparencies.
+ * If this information is known, it should be supplied when creating a texture for more efficient rendering.
+ * @see [TextureImage.transparency]($frontend).
+ * @public
+ */
+export var TextureTransparency;
+(function (TextureTransparency) {
+    /** The image contains only opaque pixels. It should not blend with other objects in the scene. */
+    TextureTransparency[TextureTransparency["Opaque"] = 0] = "Opaque";
+    /** The image contains only translucent pixels. It should blend with other objects in the scene. */
+    TextureTransparency[TextureTransparency["Translucent"] = 1] = "Translucent";
+    /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while
+     * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.
+     */
+    TextureTransparency[TextureTransparency["Mixed"] = 2] = "Mixed";
+})(TextureTransparency || (TextureTransparency = {}));
 //# sourceMappingURL=TextureProps.js.map

package/lib/esm/TextureProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextureProps.js","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 Entities\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { ImageSourceFormat } from \"./Image\";\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\n\r\n/** Properties that define a [Texture]($backend) element.\r\n * @public\r\n */\r\nexport interface TextureProps extends DefinitionElementProps {\r\n  /** Format of the image data. */\r\n  format: ImageSourceFormat;\r\n  /** The image data stored in a Base64-encoded string according to the specified format.\r\n   * @see [[Base64EncodedString.fromUint8Array]] to produce a well-formed base-64-encoded string.\r\n   * @see [[Base64EncodedString.toUint8Array]] to decode the bytes.\r\n   */\r\n  data: Base64EncodedString;\r\n  /** An optional description of the texture. */\r\n  description?: string;\r\n}\r\n\r\n/** Properties that specify what texture should be loaded and how it should be loaded.\r\n * @public\r\n */\r\nexport interface TextureLoadProps {\r\n  /** A valid Id64 string identifying the texture */\r\n  name: Id64String;\r\n  /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */\r\n  maxTextureSize?: number;\r\n}\r\n\r\n/** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].\r\n * @public\r\n */\r\nexport interface TextureData {\r\n  /** The width of the image, possibly reduced from the original width based on [[TextureLoadProps.maxTextureSize]]. */\r\n  width: number;\r\n  /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */\r\n  height: number;\r\n  /** The format of the returned data, Jpeg or Png. */\r\n  format: ImageSourceFormat;\r\n  /** returned byte data */\r\n  bytes: Uint8Array;\r\n}\r\n"]}
+{"version":3,"file":"TextureProps.js","sourceRoot":"","sources":["../../src/TextureProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAgCH;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,mBASX;AATD,WAAY,mBAAmB;IAC7B,kGAAkG;IAClG,iEAAM,CAAA;IACN,mGAAmG;IACnG,2EAAW,CAAA;IACX;;OAEG;IACH,+DAAK,CAAA;AACP,CAAC,EATW,mBAAmB,KAAnB,mBAAmB,QAS9B","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 Entities\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { ImageSourceFormat } from \"./Image\";\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\n\r\n/** Properties that define a [Texture]($backend) element.\r\n * @public\r\n */\r\nexport interface TextureProps extends DefinitionElementProps {\r\n  /** Format of the image data. */\r\n  format: ImageSourceFormat;\r\n  /** The image data stored in a Base64-encoded string according to the specified format.\r\n   * @see [[Base64EncodedString.fromUint8Array]] to produce a well-formed base-64-encoded string.\r\n   * @see [[Base64EncodedString.toUint8Array]] to decode the bytes.\r\n   */\r\n  data: Base64EncodedString;\r\n  /** An optional description of the texture. */\r\n  description?: string;\r\n}\r\n\r\n/** Properties that specify what texture should be loaded and how it should be loaded.\r\n * @public\r\n */\r\nexport interface TextureLoadProps {\r\n  /** A valid Id64 string identifying the texture */\r\n  name: Id64String;\r\n  /** Maximum texture size supported by the client. If specified, the texture will be downsampled so both of its dimensions adhere to this size. */\r\n  maxTextureSize?: number;\r\n}\r\n\r\n/** Describes the type of transparency in the pixels of a [TextureImage]($frontend).\r\n * Each pixel can be classified as either opaque or translucent.\r\n * The transparency of the image as a whole is based on the combination of pixel transparencies.\r\n * If this information is known, it should be supplied when creating a texture for more efficient rendering.\r\n * @see [TextureImage.transparency]($frontend).\r\n * @public\r\n */\r\nexport enum TextureTransparency {\r\n  /** The image contains only opaque pixels. It should not blend with other objects in the scene. */\r\n  Opaque,\r\n  /** The image contains only translucent pixels. It should blend with other objects in the scene. */\r\n  Translucent,\r\n  /** The image contains both opaque and translucent pixels. The translucent pixels should blend with other objects in the scene, while\r\n   * the opaque pixels should not. Rendering this type of transparency is somewhat more expensive.\r\n   */\r\n  Mixed,\r\n}\r\n\r\n/** Information about [Texture]($backend) data returned by [[IModelReadRpcInterface.queryTextureData]].\r\n * @public\r\n */\r\nexport interface TextureData {\r\n  /** The width of the image, possibly reduced from the original width based on [[TextureLoadProps.maxTextureSize]]. */\r\n  width: number;\r\n  /** The height of the image, possibly reduced from the original height based on [[TextureLoadProps.maxTextureSize]]. */\r\n  height: number;\r\n  /** The format of the image (Jpeg or Png). */\r\n  format: ImageSourceFormat;\r\n  /** The encoded image bytes. */\r\n  bytes: Uint8Array;\r\n  /** Information about the transparency of the texture image. Default: [[TextureTransparency.Mixed]]. */\r\n  transparency?: TextureTransparency;\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-common",
-  "version": "3.0.0-dev.172",
+  "version": "3.0.0-dev.176",
   "description": "iTwin.js components common to frontend and backend",
   "main": "lib/cjs/core-common.js",
   "module": "lib/esm/core-common.js",
@@ -29,14 +29,14 @@
     "js-base64": "^3.6.1"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^3.0.0-dev.172",
-    "@itwin/core-geometry": "^3.0.0-dev.172"
+    "@itwin/core-bentley": "^3.0.0-dev.176",
+    "@itwin/core-geometry": "^3.0.0-dev.176"
   },
   "devDependencies": {
-    "@itwin/build-tools": "3.0.0-dev.172",
-    "@itwin/core-bentley": "3.0.0-dev.172",
-    "@itwin/core-geometry": "3.0.0-dev.172",
-    "@itwin/eslint-plugin": "3.0.0-dev.172",
+    "@itwin/build-tools": "3.0.0-dev.176",
+    "@itwin/core-bentley": "3.0.0-dev.176",
+    "@itwin/core-geometry": "3.0.0-dev.176",
+    "@itwin/eslint-plugin": "3.0.0-dev.176",
     "@types/chai": "^4.1.4",
     "@types/flatbuffers": "~1.10.0",
     "@types/mocha": "^8.2.2",