@babylonjs/core 5.43.2 → 5.45.0

package/Materials/Textures/ktx2decoderTypes.d.ts

@@ -0,0 +1,215 @@
+export declare enum SourceTextureFormat {
+    ETC1S = 0,
+    UASTC4x4 = 1
+}
+export declare enum TranscodeTarget {
+    ASTC_4X4_RGBA = 0,
+    BC7_RGBA = 1,
+    BC3_RGBA = 2,
+    BC1_RGB = 3,
+    PVRTC1_4_RGBA = 4,
+    PVRTC1_4_RGB = 5,
+    ETC2_RGBA = 6,
+    ETC1_RGB = 7,
+    RGBA32 = 8,
+    R8 = 9,
+    RG8 = 10
+}
+export declare enum EngineFormat {
+    COMPRESSED_RGBA_BPTC_UNORM_EXT = 36492,
+    COMPRESSED_RGBA_ASTC_4X4_KHR = 37808,
+    COMPRESSED_RGB_S3TC_DXT1_EXT = 33776,
+    COMPRESSED_RGBA_S3TC_DXT5_EXT = 33779,
+    COMPRESSED_RGBA_PVRTC_4BPPV1_IMG = 35842,
+    COMPRESSED_RGB_PVRTC_4BPPV1_IMG = 35840,
+    COMPRESSED_RGBA8_ETC2_EAC = 37496,
+    COMPRESSED_RGB8_ETC2 = 37492,
+    COMPRESSED_RGB_ETC1_WEBGL = 36196,
+    RGBA8Format = 32856,
+    R8Format = 33321,
+    RG8Format = 33323
+}
+/**
+ * Leaf node of a decision tree
+ * It defines the transcoding format to use to transcode the texture as well as the corresponding format to use at the engine level when creating the texture
+ */
+export interface ILeaf {
+    /**
+     * The format to transcode to
+     */
+    transcodeFormat: TranscodeTarget;
+    /**
+     * The format to use when creating the texture at the engine level after it has been transcoded to transcodeFormat
+     */
+    engineFormat: EngineFormat;
+    /**
+     * Whether the texture must be rounded to a multiple of 4 (should normally be the case for all compressed formats). Default: true
+     */
+    roundToMultiple4?: boolean;
+}
+/**
+ * Regular node of a decision tree
+ *
+ * Each property (except for "yes" and "no"), if not empty, will be checked in order to determine the next node to select.
+ * If all checks are successful, the "yes" node will be selected, else the "no" node will be selected.
+ */
+export interface INode {
+    /**
+     * The name of the capability to check. Can be one of the following:
+     *      astc
+     *      bptc
+     *      s3tc
+     *      pvrtc
+     *      etc2
+     *      etc1
+     */
+    cap?: string;
+    /**
+     * The name of the option to check from the options object passed to the KTX2 decode function. {@link IKTX2DecoderOptions}
+     */
+    option?: string;
+    /**
+     * Checks if alpha is present in the texture
+     */
+    alpha?: boolean;
+    /**
+     * Checks the currently selected transcoding format.
+     */
+    transcodeFormat?: TranscodeTarget | TranscodeTarget[];
+    /**
+     * Checks that the texture is a power of two
+     */
+    needsPowerOfTwo?: boolean;
+    /**
+     * The node to select if all checks are successful
+     */
+    yes?: INode | ILeaf;
+    /**
+     * The node to select if at least one check is not successful
+     */
+    no?: INode | ILeaf;
+}
+/**
+ * Decision tree used to determine the transcoding format to use for a given source texture format
+ */
+export interface IDecisionTree {
+    /**
+     * textureFormat can be either UASTC or ETC1S
+     */
+    [textureFormat: string]: INode;
+}
+/**
+ * Result of the KTX2 decode function
+ */
+export interface IDecodedData {
+    /**
+     * Width of the texture
+     */
+    width: number;
+    /**
+     * Height of the texture
+     */
+    height: number;
+    /**
+     * The format to use when creating the texture at the engine level
+     * This corresponds to the engineFormat property of the leaf node of the decision tree
+     */
+    transcodedFormat: number;
+    /**
+     * List of mipmap levels.
+     * The first element is the base level, the last element is the smallest mipmap level (if more than one mipmap level is present)
+     */
+    mipmaps: Array<IMipmap>;
+    /**
+     * Whether the texture data is in gamma space or not
+     */
+    isInGammaSpace: boolean;
+    /**
+     * Whether the texture has an alpha channel or not
+     */
+    hasAlpha: boolean;
+    /**
+     * The name of the transcoder used to transcode the texture
+     */
+    transcoderName: string;
+    /**
+     * The errors (if any) encountered during the decoding process
+     */
+    errors?: string;
+}
+/**
+ * Defines a mipmap level
+ */
+export interface IMipmap {
+    /**
+     * The data of the mipmap level
+     */
+    data: Uint8Array | null;
+    /**
+     * The width of the mipmap level
+     */
+    width: number;
+    /**
+     * The height of the mipmap level
+     */
+    height: number;
+}
+/**
+ * The compressed texture formats supported by the browser
+ */
+export interface ICompressedFormatCapabilities {
+    /**
+     * Whether the browser supports ASTC
+     */
+    astc?: boolean;
+    /**
+     * Whether the browser supports BPTC
+     */
+    bptc?: boolean;
+    /**
+     * Whether the browser supports S3TC
+     */
+    s3tc?: boolean;
+    /**
+     * Whether the browser supports PVRTC
+     */
+    pvrtc?: boolean;
+    /**
+     * Whether the browser supports ETC2
+     */
+    etc2?: boolean;
+    /**
+     * Whether the browser supports ETC1
+     */
+    etc1?: boolean;
+}
+/**
+ * Options passed to the KTX2 decode function
+ */
+export interface IKTX2DecoderOptions {
+    /** use RGBA format if ASTC and BC7 are not available as transcoded format */
+    useRGBAIfASTCBC7NotAvailableWhenUASTC?: boolean;
+    /** force to always use (uncompressed) RGBA for transcoded format */
+    forceRGBA?: boolean;
+    /** force to always use (uncompressed) R8 for transcoded format */
+    forceR8?: boolean;
+    /** force to always use (uncompressed) RG8 for transcoded format */
+    forceRG8?: boolean;
+    /**
+     * list of transcoders to bypass when looking for a suitable transcoder. The available transcoders are:
+     *      UniversalTranscoder_UASTC_ASTC
+     *      UniversalTranscoder_UASTC_BC7
+     *      UniversalTranscoder_UASTC_RGBA_UNORM
+     *      UniversalTranscoder_UASTC_RGBA_SRGB
+     *      UniversalTranscoder_UASTC_R8_UNORM
+     *      UniversalTranscoder_UASTC_RG8_UNORM
+     *      MSCTranscoder
+     */
+    bypassTranscoders?: string[];
+    /**
+     * Custom decision tree to apply after the default decision tree has selected a transcoding format.
+     * Allows the user to override the default decision tree selection.
+     * The decision tree can use the INode.transcodeFormat property to base its decision on the transcoding format selected by the default decision tree.
+     */
+    transcodeFormatDecisionTree?: IDecisionTree;
+}

package/Materials/Textures/ktx2decoderTypes.js

@@ -0,0 +1,35 @@
+export var SourceTextureFormat;
+(function (SourceTextureFormat) {
+    SourceTextureFormat[SourceTextureFormat["ETC1S"] = 0] = "ETC1S";
+    SourceTextureFormat[SourceTextureFormat["UASTC4x4"] = 1] = "UASTC4x4";
+})(SourceTextureFormat || (SourceTextureFormat = {}));
+export var TranscodeTarget;
+(function (TranscodeTarget) {
+    TranscodeTarget[TranscodeTarget["ASTC_4X4_RGBA"] = 0] = "ASTC_4X4_RGBA";
+    TranscodeTarget[TranscodeTarget["BC7_RGBA"] = 1] = "BC7_RGBA";
+    TranscodeTarget[TranscodeTarget["BC3_RGBA"] = 2] = "BC3_RGBA";
+    TranscodeTarget[TranscodeTarget["BC1_RGB"] = 3] = "BC1_RGB";
+    TranscodeTarget[TranscodeTarget["PVRTC1_4_RGBA"] = 4] = "PVRTC1_4_RGBA";
+    TranscodeTarget[TranscodeTarget["PVRTC1_4_RGB"] = 5] = "PVRTC1_4_RGB";
+    TranscodeTarget[TranscodeTarget["ETC2_RGBA"] = 6] = "ETC2_RGBA";
+    TranscodeTarget[TranscodeTarget["ETC1_RGB"] = 7] = "ETC1_RGB";
+    TranscodeTarget[TranscodeTarget["RGBA32"] = 8] = "RGBA32";
+    TranscodeTarget[TranscodeTarget["R8"] = 9] = "R8";
+    TranscodeTarget[TranscodeTarget["RG8"] = 10] = "RG8";
+})(TranscodeTarget || (TranscodeTarget = {}));
+export var EngineFormat;
+(function (EngineFormat) {
+    EngineFormat[EngineFormat["COMPRESSED_RGBA_BPTC_UNORM_EXT"] = 36492] = "COMPRESSED_RGBA_BPTC_UNORM_EXT";
+    EngineFormat[EngineFormat["COMPRESSED_RGBA_ASTC_4X4_KHR"] = 37808] = "COMPRESSED_RGBA_ASTC_4X4_KHR";
+    EngineFormat[EngineFormat["COMPRESSED_RGB_S3TC_DXT1_EXT"] = 33776] = "COMPRESSED_RGB_S3TC_DXT1_EXT";
+    EngineFormat[EngineFormat["COMPRESSED_RGBA_S3TC_DXT5_EXT"] = 33779] = "COMPRESSED_RGBA_S3TC_DXT5_EXT";
+    EngineFormat[EngineFormat["COMPRESSED_RGBA_PVRTC_4BPPV1_IMG"] = 35842] = "COMPRESSED_RGBA_PVRTC_4BPPV1_IMG";
+    EngineFormat[EngineFormat["COMPRESSED_RGB_PVRTC_4BPPV1_IMG"] = 35840] = "COMPRESSED_RGB_PVRTC_4BPPV1_IMG";
+    EngineFormat[EngineFormat["COMPRESSED_RGBA8_ETC2_EAC"] = 37496] = "COMPRESSED_RGBA8_ETC2_EAC";
+    EngineFormat[EngineFormat["COMPRESSED_RGB8_ETC2"] = 37492] = "COMPRESSED_RGB8_ETC2";
+    EngineFormat[EngineFormat["COMPRESSED_RGB_ETC1_WEBGL"] = 36196] = "COMPRESSED_RGB_ETC1_WEBGL";
+    EngineFormat[EngineFormat["RGBA8Format"] = 32856] = "RGBA8Format";
+    EngineFormat[EngineFormat["R8Format"] = 33321] = "R8Format";
+    EngineFormat[EngineFormat["RG8Format"] = 33323] = "RG8Format";
+})(EngineFormat || (EngineFormat = {}));
+//# sourceMappingURL=ktx2decoderTypes.js.map

package/Materials/Textures/ktx2decoderTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ktx2decoderTypes.js","sourceRoot":"","sources":["../../../../../lts/core/generated/Materials/Textures/ktx2decoderTypes.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,+DAAK,CAAA;IACL,qEAAQ,CAAA;AACZ,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AAED,MAAM,CAAN,IAAY,eAYX;AAZD,WAAY,eAAe;IACvB,uEAAa,CAAA;IACb,6DAAQ,CAAA;IACR,6DAAQ,CAAA;IACR,2DAAO,CAAA;IACP,uEAAa,CAAA;IACb,qEAAY,CAAA;IACZ,+DAAS,CAAA;IACT,6DAAQ,CAAA;IACR,yDAAM,CAAA;IACN,iDAAE,CAAA;IACF,oDAAG,CAAA;AACP,CAAC,EAZW,eAAe,KAAf,eAAe,QAY1B;AAED,MAAM,CAAN,IAAY,YAaX;AAbD,WAAY,YAAY;IACpB,uGAAuC,CAAA;IACvC,mGAAqC,CAAA;IACrC,mGAAqC,CAAA;IACrC,qGAAsC,CAAA;IACtC,2GAAyC,CAAA;IACzC,yGAAwC,CAAA;IACxC,6FAAkC,CAAA;IAClC,mFAA6B,CAAA;IAC7B,6FAAkC,CAAA;IAClC,iEAAoB,CAAA;IACpB,2DAAiB,CAAA;IACjB,6DAAkB,CAAA;AACtB,CAAC,EAbW,YAAY,KAAZ,YAAY,QAavB","sourcesContent":["export enum SourceTextureFormat {\r\n    ETC1S,\r\n    UASTC4x4,\r\n}\r\n\r\nexport enum TranscodeTarget {\r\n    ASTC_4X4_RGBA,\r\n    BC7_RGBA,\r\n    BC3_RGBA,\r\n    BC1_RGB,\r\n    PVRTC1_4_RGBA,\r\n    PVRTC1_4_RGB,\r\n    ETC2_RGBA,\r\n    ETC1_RGB,\r\n    RGBA32,\r\n    R8,\r\n    RG8,\r\n}\r\n\r\nexport enum EngineFormat {\r\n    COMPRESSED_RGBA_BPTC_UNORM_EXT = 0x8e8c,\r\n    COMPRESSED_RGBA_ASTC_4X4_KHR = 0x93b0,\r\n    COMPRESSED_RGB_S3TC_DXT1_EXT = 0x83f0,\r\n    COMPRESSED_RGBA_S3TC_DXT5_EXT = 0x83f3,\r\n    COMPRESSED_RGBA_PVRTC_4BPPV1_IMG = 0x8c02,\r\n    COMPRESSED_RGB_PVRTC_4BPPV1_IMG = 0x8c00,\r\n    COMPRESSED_RGBA8_ETC2_EAC = 0x9278,\r\n    COMPRESSED_RGB8_ETC2 = 0x9274,\r\n    COMPRESSED_RGB_ETC1_WEBGL = 0x8d64,\r\n    RGBA8Format = 0x8058,\r\n    R8Format = 0x8229,\r\n    RG8Format = 0x822b,\r\n}\r\n\r\n/**\r\n * Leaf node of a decision tree\r\n * It defines the transcoding format to use to transcode the texture as well as the corresponding format to use at the engine level when creating the texture\r\n */\r\nexport interface ILeaf {\r\n    /**\r\n     * The format to transcode to\r\n     */\r\n    transcodeFormat: TranscodeTarget;\r\n\r\n    /**\r\n     * The format to use when creating the texture at the engine level after it has been transcoded to transcodeFormat\r\n     */\r\n    engineFormat: EngineFormat;\r\n\r\n    /**\r\n     * Whether the texture must be rounded to a multiple of 4 (should normally be the case for all compressed formats). Default: true\r\n     */\r\n    roundToMultiple4?: boolean;\r\n}\r\n\r\n/**\r\n * Regular node of a decision tree\r\n *\r\n * Each property (except for \"yes\" and \"no\"), if not empty, will be checked in order to determine the next node to select.\r\n * If all checks are successful, the \"yes\" node will be selected, else the \"no\" node will be selected.\r\n */\r\nexport interface INode {\r\n    /**\r\n     * The name of the capability to check. Can be one of the following:\r\n     *      astc\r\n     *      bptc\r\n     *      s3tc\r\n     *      pvrtc\r\n     *      etc2\r\n     *      etc1\r\n     */\r\n    cap?: string;\r\n\r\n    /**\r\n     * The name of the option to check from the options object passed to the KTX2 decode function. {@link IKTX2DecoderOptions}\r\n     */\r\n    option?: string;\r\n\r\n    /**\r\n     * Checks if alpha is present in the texture\r\n     */\r\n    alpha?: boolean;\r\n\r\n    /**\r\n     * Checks the currently selected transcoding format.\r\n     */\r\n    transcodeFormat?: TranscodeTarget | TranscodeTarget[];\r\n\r\n    /**\r\n     * Checks that the texture is a power of two\r\n     */\r\n    needsPowerOfTwo?: boolean;\r\n\r\n    /**\r\n     * The node to select if all checks are successful\r\n     */\r\n    yes?: INode | ILeaf;\r\n\r\n    /**\r\n     * The node to select if at least one check is not successful\r\n     */\r\n    no?: INode | ILeaf;\r\n}\r\n\r\n/**\r\n * Decision tree used to determine the transcoding format to use for a given source texture format\r\n */\r\nexport interface IDecisionTree {\r\n    /**\r\n     * textureFormat can be either UASTC or ETC1S\r\n     */\r\n    [textureFormat: string]: INode;\r\n}\r\n\r\n/**\r\n * Result of the KTX2 decode function\r\n */\r\nexport interface IDecodedData {\r\n    /**\r\n     * Width of the texture\r\n     */\r\n    width: number;\r\n\r\n    /**\r\n     * Height of the texture\r\n     */\r\n    height: number;\r\n\r\n    /**\r\n     * The format to use when creating the texture at the engine level\r\n     * This corresponds to the engineFormat property of the leaf node of the decision tree\r\n     */\r\n    transcodedFormat: number;\r\n\r\n    /**\r\n     * List of mipmap levels.\r\n     * The first element is the base level, the last element is the smallest mipmap level (if more than one mipmap level is present)\r\n     */\r\n    mipmaps: Array<IMipmap>;\r\n\r\n    /**\r\n     * Whether the texture data is in gamma space or not\r\n     */\r\n    isInGammaSpace: boolean;\r\n\r\n    /**\r\n     * Whether the texture has an alpha channel or not\r\n     */\r\n    hasAlpha: boolean;\r\n\r\n    /**\r\n     * The name of the transcoder used to transcode the texture\r\n     */\r\n    transcoderName: string;\r\n\r\n    /**\r\n     * The errors (if any) encountered during the decoding process\r\n     */\r\n    errors?: string;\r\n}\r\n\r\n/**\r\n * Defines a mipmap level\r\n */\r\nexport interface IMipmap {\r\n    /**\r\n     * The data of the mipmap level\r\n     */\r\n    data: Uint8Array | null;\r\n\r\n    /**\r\n     * The width of the mipmap level\r\n     */\r\n    width: number;\r\n\r\n    /**\r\n     * The height of the mipmap level\r\n     */\r\n    height: number;\r\n}\r\n\r\n/**\r\n * The compressed texture formats supported by the browser\r\n */\r\nexport interface ICompressedFormatCapabilities {\r\n    /**\r\n     * Whether the browser supports ASTC\r\n     */\r\n    astc?: boolean;\r\n\r\n    /**\r\n     * Whether the browser supports BPTC\r\n     */\r\n    bptc?: boolean;\r\n\r\n    /**\r\n     * Whether the browser supports S3TC\r\n     */\r\n    s3tc?: boolean;\r\n\r\n    /**\r\n     * Whether the browser supports PVRTC\r\n     */\r\n    pvrtc?: boolean;\r\n\r\n    /**\r\n     * Whether the browser supports ETC2\r\n     */\r\n    etc2?: boolean;\r\n\r\n    /**\r\n     * Whether the browser supports ETC1\r\n     */\r\n    etc1?: boolean;\r\n}\r\n\r\n/**\r\n * Options passed to the KTX2 decode function\r\n */\r\nexport interface IKTX2DecoderOptions {\r\n    /** use RGBA format if ASTC and BC7 are not available as transcoded format */\r\n    useRGBAIfASTCBC7NotAvailableWhenUASTC?: boolean;\r\n\r\n    /** force to always use (uncompressed) RGBA for transcoded format */\r\n    forceRGBA?: boolean;\r\n\r\n    /** force to always use (uncompressed) R8 for transcoded format */\r\n    forceR8?: boolean;\r\n\r\n    /** force to always use (uncompressed) RG8 for transcoded format */\r\n    forceRG8?: boolean;\r\n\r\n    /**\r\n     * list of transcoders to bypass when looking for a suitable transcoder. The available transcoders are:\r\n     *      UniversalTranscoder_UASTC_ASTC\r\n     *      UniversalTranscoder_UASTC_BC7\r\n     *      UniversalTranscoder_UASTC_RGBA_UNORM\r\n     *      UniversalTranscoder_UASTC_RGBA_SRGB\r\n     *      UniversalTranscoder_UASTC_R8_UNORM\r\n     *      UniversalTranscoder_UASTC_RG8_UNORM\r\n     *      MSCTranscoder\r\n     */\r\n    bypassTranscoders?: string[];\r\n\r\n    /**\r\n     * Custom decision tree to apply after the default decision tree has selected a transcoding format.\r\n     * Allows the user to override the default decision tree selection.\r\n     * The decision tree can use the INode.transcodeFormat property to base its decision on the transcoding format selected by the default decision tree.\r\n     */\r\n    transcodeFormatDecisionTree?: IDecisionTree;\r\n}\r\n"]}

package/Materials/Textures/texture.d.ts

@@ -281,7 +281,7 @@ export declare class Texture extends BaseTexture {
      * @param onLoad callback called when the texture is loaded  (defaults to null)
      * @param forcedExtension defines the extension to use to pick the right loader
      */
-    updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void, forcedExtension?: string): void;
+    updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, onLoad?: () => void, forcedExtension?: string): void;
     /**
      * Finish the loading sequence of a texture flagged as delayed load.
      * @internal