@dreamcomposer/engine-types 0.0.17-next.1 → 0.0.19

package/Layer.d.ts

@@ -22,15 +22,11 @@ export interface Layer {
    */
   visible?: boolean;
   /**
-   * A URL that points to the texture of the layer.
-   * For non PNG images the file format must be specified either in the URL itself or via a TexturUrl and TexturUrlCollection object
+   * A url that points to the texture of the layer.
+   *
+   * Must be in the PNG format.
    */
-  textureUrl:
-    | string
-    | TextureUrl
-    | CompressedTextureUrlCollection
-    | Blob
-    | TextureBlob;
+  textureUrl: string | Blob;
   /**
    * Whether or not the layer is overprinted with the texture.
    *
@@ -92,7 +88,7 @@ export interface PatternEmbossingConfiguration {
   sizePx: [number, number];
 
   /**
-   * PPI of the textureforcedExtension
+   * PPI of the texture
    */
   ppi: number;
 
@@ -102,73 +98,6 @@ export interface PatternEmbossingConfiguration {
   offset?: [number, number];
 }
 
-export interface TextureUrl {
-  /**
-   * The public url of the texture
-   */
-  url: string;
-  /**
-   * Define the file extension of the texture.
-   * This is only necessary, if the url does not contain the extension itself (e.g. ".png", "-dxt.ktx")
-   */
-  fileExtension?: string;
-  /**
-   * Define the texture compression that is stored inside (e.g. "dxt", "etc1", "astc")
-   * Currently comporessed textures are only supported inside a .ktx file
-   */
-  textureCompressionFormat?: string;
-}
-export interface TextureBlob {
-  /**
-   * The texture itself as an Blob
-   */
-  blob: Blob;
-  /**
-   * Define the file extension of the texture (e.g. ".png", ".jpg", ".ktx")
-   */
-  fileExtension?: string;
-  /**
-   * Define the texture compression that is stored inside (e.g. "dxt", "etc1", "astc")
-   * Currently comporessed textures are only supported inside a .ktx file
-   */
-  textureCompressionFormat?: string;
-}
-
-/**
- * A collection of URLs for a single texture in diffrent compression formats
- */
-export interface CompressedTextureUrlCollection {
-  /**
-   * The URL, that is used, if the GPU does not support any of the provied compression formats.
-   * Must be referencing to a PNG image
-   */
-  fallbackURL: string;
-  /**
-   * URL that points to an ASTC compressed textur in a KTX file format
-   */
-  astcKtxURL?: string;
-  /**
-   * URL that points to an ATC compressed textur in a KTX file format
-   */
-  atcKtxURL?: string;
-  /**
-   * URL that points to an DXT3 or DXT5 compressed textur in a KTX file format
-   */
-  dxtKtxURL?: string;
-  /**
-   * URL that points to an ETC-1 compressed textur in a KTX file format
-   */
-  etc1KtxURL?: string;
-  /**
-   * URL that points to an ETC-2 compressed textur in a KTX file format
-   */
-  etc2KtxURL?: string;
-  /**
-   * URL that points to an PVRTC compressed textur in a KTX file format
-   */
-  pvrtcKtxURL?: string;
-}
-
 export type TextureOverride<T> = Record<
   string,
   Partial<T> | Record<string, Partial<T>>

package/from-engine/DisplayLoadingUiMessage.d.ts

@@ -0,0 +1,9 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent whenever the loading ui should be displayed.
+ */
+export interface DisplayLoadingUiMessage
+  extends FromEngineMessage<"display-loading-ui"> {
+  payload: {};
+}

package/from-engine/EngineReadyMessage.d.ts

@@ -1,14 +1,9 @@
 import { FromEngineMessage } from "../post-messages";
 
-export interface EngineReadyEvent {
-  ready: boolean;
-  supportedCompressedTextureFormats: string[];
-}
-
 /**
  * A message that gets send by the engine when it's ready to receive commands.
  * You must not send any messages before receiving this message.
  */
 export interface EngineReadyMessage extends FromEngineMessage<"engine-ready"> {
-  payload: EngineReadyEvent;
+  payload: boolean;
 }

package/from-engine/HideLoadingUiMessage.d.ts

@@ -0,0 +1,9 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent whenever the loading ui should be hidden.
+ */
+export interface HideLoadingUiMessage
+  extends FromEngineMessage<"hide-loading-ui"> {
+  payload: {};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreamcomposer/engine-types",
-  "version": "0.0.17-next.1",
+  "version": "0.0.19",
   "description": "The type definitions for messages from and to the engine",
   "license": "UNLICENSED",
   "private": false,
@@ -8,7 +8,7 @@
     "**/*.ts"
   ],
   "devDependencies": {
-    "@babylonjs/core": "5.8.2",
+    "@babylonjs/core": "5.0.0-alpha.58",
     "prettier": "^2.5.1",
     "typescript": "^4.4.4"
   },

package/post-messages.d.ts

@@ -38,6 +38,8 @@ import { SetUseFramingAnimation } from "./to-engine/SetUseFramingAnimation";
 import { SetSkeletonStatesMessage } from "./to-engine/SetSkeletonStatesMessage";
 import { RecenterSkeletonObjectsMessage } from "./to-engine/RecenterSkeletonObjectsMessage";
 import { SetShadowPlaneVisibilityMessage } from "./to-engine/SetShadowPlaneVisibilityMessage";
+import { DisplayLoadingUiMessage } from "./from-engine/DisplayLoadingUiMessage";
+import { HideLoadingUiMessage } from "./from-engine/HideLoadingUiMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -63,8 +65,10 @@ export interface ToEngineMessage<Channel> {
 export type FromEnginePostMessage =
   | AckMessage
   | CanvasImageUrlMessage
+  | DisplayLoadingUiMessage
   | EngineReadyMessage
   | HideGuiMessage
+  | HideLoadingUiMessage
   | KeyDownMessage
   | PointerEventMessage
   | SetEffectsSettingsAckMessage

package/to-engine/SetCutoutTextureMessage.d.ts

@@ -9,8 +9,9 @@ import { ToEngineMessage } from "../post-messages";
 export interface SetCutoutTextureMessage
   extends ToEngineMessage<"set-cutout-texture"> {
   /**
-   * The cutout mask in the PNG format or an empty string to reset it (i.e.,
-   * setting a texture with no cutouts).
+   * The cutout mask in the PNG format. Can either be a blob or a URL to the
+   * cutout texture. An empty string is used to reset it (i.e., setting a
+   * texture with no cutouts).
    */
-  payload: Blob | "";
+  payload: Blob | string | "";
 }