@dreamcomposer/engine-types 0.0.30 → 0.0.32-next.1

package/Layer.d.ts

@@ -24,9 +24,11 @@ export interface Layer {
   /**
    * The texture of the layer, either a url or a blob.
    *
-   * Must be in the PNG format.
+   * For non PNG images the file format must be specified:
+   * - in the URL itself
+   * - via a TextureUrl and TextureUrlCollection object
    */
-  texture: string | Blob;
+  texture: string | TextureUrl | Blob | TextureBlob;
   /**
    * Whether or not the layer is overprinted with the texture.
    *
@@ -81,6 +83,31 @@ export interface PatternEmbossingConfiguration {
   rotation?: number;
 }
 
+export interface TextureUrl {
+  /**
+   * The public url of the texture
+   */
+  url: string;
+  /**
+   * Define the file extension of the texture. (e.g. ".png", ".jpg", ".basis")
+   *
+   * This is only necessary, if the url does not contain the extension itself
+   */
+  fileExtension?: string;
+}
+export interface TextureBlob {
+  /**
+   * The texture itself as an Blob
+   */
+  blob: Blob;
+  /**
+   * Define the file extension of the texture (e.g. ".png", ".jpg", ".ktx2")
+   *
+   * This is only necessary, if the blob is not a common image file (.png, .jpg)
+   */
+  fileExtension?: string;
+}
+
 export type TextureOverride<T> = Record<
   string,
   Partial<T> | Record<string, Partial<T>>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreamcomposer/engine-types",
-  "version": "0.0.30",
+  "version": "0.0.32-next.1",
   "description": "The type definitions for messages from and to the engine",
   "license": "UNLICENSED",
   "private": false,

package/to-engine/SetStageMappingsMessage.d.ts

@@ -39,6 +39,41 @@ export interface SetStageMappingsMessage
        * and `1`).
        */
       height: number;
+      /**
+       * Defines a sub area of the target geometry, where the stage will be displayed
+       *
+       * If no subMeshUVArea is defined, the whole area is used.
+       */
+      subMeshUVArea?: {
+        /**
+         * The x position where the target uv box begins.
+         *
+         * This is not a pixel value but a percentage (i.e., a value between `0`
+         * and `1`).
+         */
+        x: number;
+        /**
+         * The y position where the target uv box begins.
+         *
+         * This is not a pixel value but a percentage (i.e., a value between `0`
+         * and `1`).
+         */
+        y: number;
+        /**
+         * The width of target uv box
+         *
+         * This is not a pixel value but a percentage (i.e., a value between `0`
+         * and `1`).
+         */
+        width: number;
+        /**
+         * The height of target uv box
+         *
+         * This is not a pixel value but a percentage (i.e., a value between `0`
+         * and `1`).
+         */
+        height: number;
+      };
     };
   };
 }