@cesdk/engine 1.8.0-alpha.0 → 1.8.0-alpha.3

package/index.d.ts

@@ -1741,18 +1741,24 @@ declare class CreativeEngine {
     scene: SceneAPI;
     variable: VariableAPI;
 
+    get element(): HTMLCreativeEngineCanvasElement | undefined;
     /**
      * Dispose the engine.
      */
     dispose(): void;
     /**
      * Initialize a `CreativeEngine` using the given `canvas` element and an optional config.
-     * @param config - A configuration object.
+     * @param config - An optional configuration object.
      * @param canvas - The canvas to use for drawing. Optional, if no canvas is provided,
      *                 the engine works with an internal offscreen-canvas.
      * @returns An engine instance.
      */
-    static init(config?: Partial<Configuration>, canvas?: HTMLCanvasElement | OffscreenCanvas): Promise<CreativeEngine>;
+    static init(config?: Partial<Configuration>): Promise<CreativeEngine & {
+        readonly element: HTMLCreativeEngineCanvasElement;
+    }>;
+    static init(config: Partial<Configuration> | undefined, canvas: HTMLCanvasElement | OffscreenCanvas): Promise<CreativeEngine & {
+        readonly element: undefined;
+    }>;
 }
 export default CreativeEngine;
 
@@ -2141,6 +2147,23 @@ declare type Groups = string[];
  */
 declare type HexColorString = string;
 
+/**
+ * A wrapper around a plain canvas
+ *
+ * The idea is to shield the user from the weird semantics of changing width
+ * and height of a canvas by making this a opaque block element instead and
+ * managing the internal render resolution of the canvas dynamically
+ *
+ * @public
+ */
+export declare class HTMLCreativeEngineCanvasElement extends HTMLElement {
+    #private;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+
+}
+
 /** @public */
 declare type ImageDefinition = Preset & {
     imageURL: string;