@cesdk/engine 1.76.0-nightly.20260522 → 1.76.0-rc.0

package/index.d.ts

@@ -6655,7 +6655,7 @@ export declare function _createReactiveProperty<T>(initialValue: T, options?: _R
  */
 export declare type CreateSceneOptions = {
     /** The page options */
-    page: {
+    page?: {
         /** The size of the page */
         size: number | {
             width: number;
@@ -6664,6 +6664,15 @@ export declare type CreateSceneOptions = {
         /** The background color of the page */
         color?: Color;
     };
+    /**
+     * The design unit of the new scene. Defaults to `Pixel`.
+     */
+    designUnit?: SceneDesignUnit;
+    /**
+     * The unit in which font sizes for `setTextFontSize` and `getTextFontSizes` are interpreted.
+     * If omitted, it is paired with `designUnit`: `Pixel` scenes get `Pixel`, all other scenes get `Point`.
+     */
+    fontSizeUnit?: SceneFontSizeUnit;
 };
 
 /**
@@ -9454,6 +9463,8 @@ export declare class SceneAPI {
      *
      * ```javascript
      * const scene = engine.scene.create(layout);
+     * // With a specific design unit and auto-paired font-size unit:
+     * const pxScene = engine.scene.create('Free', { designUnit: 'Pixel' });
      * ```
      *
      * @category Scene Creation
@@ -9462,6 +9473,9 @@ export declare class SceneAPI {
      *   - `page` - Page options. Properties:
      *     - `size` - The size of the page.
      *     - `color` - Optional background color of the page.
+     *   - `designUnit` - The design unit of the new scene. Defaults to `Pixel`.
+     *   - `fontSizeUnit` - The font-size unit. If omitted, paired with `designUnit`
+     *     (`Pixel` design unit → `Pixel` font unit, others → `Point`).
      * @returns The scene's handle.
      */
     create(sceneLayout?: SceneLayout, options?: CreateSceneOptions): DesignBlockId;
@@ -9605,6 +9619,30 @@ export declare class SceneAPI {
      * @returns The current design unit.
      */
     getDesignUnit(): SceneDesignUnit;
+    /**
+     * Sets the unit in which font sizes for `setTextFontSize` and `getTextFontSizes` are interpreted.
+     * The engine continues to store font sizes in points internally; this only affects how values
+     * are interpreted at the API boundary when callers don't specify a `unit` in `TextFontSizeOptions`.
+     *
+     * ```javascript
+     * engine.scene.setFontSizeUnit('Pixel');
+     * ```
+     *
+     * @category Scene Properties
+     * @param fontSizeUnit - The new font-size unit of the scene.
+     */
+    setFontSizeUnit(fontSizeUnit: SceneFontSizeUnit): void;
+    /**
+     * Returns the font-size unit of the current scene.
+     *
+     * ```javascript
+     * engine.scene.getFontSizeUnit();
+     * ```
+     *
+     * @category Scene Properties
+     * @returns The current font-size unit.
+     */
+    getFontSizeUnit(): SceneFontSizeUnit;
     /**
      * Get the layout of the current scene.
      *
@@ -9950,6 +9988,12 @@ export { SceneDesignUnit }
 /** @public */
 export declare const SceneDesignUnitValues: readonly ["Pixel", "Millimeter", "Inch"];
 
+/** @public */
+export declare type SceneFontSizeUnit = (typeof SceneFontSizeUnitValues)[number];
+
+/** @public */
+export declare const SceneFontSizeUnitValues: readonly ["Pixel", "Point"];
+
 /** @public */
 export declare type SceneLayout = (typeof SceneLayoutValues)[number];
 
@@ -10606,7 +10650,10 @@ export declare type TextDecorationStyle = 'Solid' | 'Double' | 'Dotted' | 'Dashe
  * @public
  */
 export declare interface TextFontSizeOptions {
-    /** The unit of the font size. Defaults to 'Point' */
+    /**
+     * The unit of the font size. Defaults to the scene's `fontSizeUnit`
+     * (configured via `engine.scene.setFontSizeUnit()`), which itself defaults to `'Point'`.
+     */
     unit?: FontSizeUnit;
     /** The start index of the UTF-16 range. Defaults to -1 (start of selection/text) */
     from?: number;