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

package/Layer.d.ts

@@ -22,11 +22,15 @@ export interface Layer {
    */
   visible?: boolean;
   /**
-   * A url that points to the texture of the layer.
-   *
-   * Must be in the PNG format.
+   * 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
    */
-  textureUrl: string | Blob;
+  textureUrl:
+    | string
+    | TextureUrl
+    | CompressedTextureUrlCollection
+    | Blob
+    | TextureBlob;
   /**
    * Whether or not the layer is overprinted with the texture.
    *
@@ -88,7 +92,7 @@ export interface PatternEmbossingConfiguration {
   sizePx: [number, number];
 
   /**
-   * PPI of the texture
+   * PPI of the textureforcedExtension
    */
   ppi: number;
 
@@ -98,6 +102,73 @@ 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/EngineReadyMessage.d.ts

@@ -1,9 +1,14 @@
 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: boolean;
+  payload: EngineReadyEvent;
 }

package/package.json

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

package/to-engine/SetSkeletonStatesMessage.ts

@@ -4,7 +4,8 @@ import { ToEngineMessage } from "../post-messages";
 /**
  * A message to set the mesh skeleton states
  */
-export interface SetSkeletonStatesMessage extends ToEngineMessage<"set-skeleton-states"> {
+export interface SetSkeletonStatesMessage
+  extends ToEngineMessage<"set-skeleton-states"> {
   payload: {
     /**
      * The skeleton states. The key is the name of the skeleton from the mesh.