@dreamcomposer/engine-types 0.0.75 → 0.0.76

package/{Layer.d.ts → Layer.ts}

@@ -114,3 +114,11 @@ export type TextureOverride<T> = Record<
 >;
 
 type Texture = unknown;
+
+export function isTextureBlob(obj: unknown): obj is TextureBlob {
+  return typeof obj === "object" && obj !== null && "blob" in obj;
+}
+
+export function isTextureUrl(obj: unknown): obj is TextureUrl {
+  return typeof obj === "object" && obj !== null && "url" in obj;
+}

package/package.json

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

package/post-messages.d.ts

@@ -48,6 +48,7 @@ import { SetInitialGeometryTransformMessage } from "./to-engine/SetInitialGeomet
 import { ResetGeometryTransformMessage } from "./to-engine/ResetGeometryTransformMessage";
 import { PlaceGeometryOnGroundMessage } from "./to-engine/MoveGeometryToGroundMessage";
 import { MouseEventMessage } from "./to-engine/MouseEventMessage";
+import { SetBackgroundImageMessage } from "./to-engine/SetBackgroundImageMessage";
 
 /**
  * A message sent from the engine to the embedder.
@@ -95,6 +96,7 @@ export type ToEnginePostMessage =
   | UpdateCameraPositionMessage
   | SelectedEdgesMessage
   | SetClearColorMessage
+  | SetBackgroundImageMessage
   | SetConnectionInfosMessage
   | SetCutoutTextureMessage
   | SetEdgeSelectorEnabledMessage

package/to-engine/SetBackgroundImageMessage.d.ts

@@ -0,0 +1,15 @@
+import { TextureBlob, TextureUrl } from "../Layer";
+import { ToEngineMessage } from "../post-messages";
+
+/**
+ * A message to set the scene's background image.
+ */
+export interface SetBackgroundImageMessage
+  extends ToEngineMessage<"set-background-image"> {
+  payload: {
+    texture: string | TextureUrl | Blob | TextureBlob | null;
+    options?: {
+      scalingMode?: "stretch" | "fill" | "fit";
+    };
+  };
+}