@dcl/playground-assets 7.17.1-21217092165.commit-1c2ff72 → 7.17.1-21366395728.commit-ada88b6

package/dist/alpha.d.ts

@@ -6926,8 +6926,14 @@ export declare type RaycastSystemOptions = {
  * @public
  */
 export declare interface ReactBasedUiSystem {
+    /**
+     * Destroy all UI entities and unregister related systems.
+     */
     destroy(): void;
-    setUiRenderer(ui: UiComponent): void;
+    /**
+     * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
+     */
+    setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
     /**
      * Add a UI renderer associated with an entity. The UI will be automatically cleaned up
      * when the entity is removed from the engine.
@@ -6940,10 +6946,12 @@ export declare interface ReactBasedUiSystem {
      * @param entity - The entity to associate with this UI renderer. When the entity is removed,
      *                 the UI renderer is automatically cleaned up.
      * @param ui - The UI component to render
+     * @param options - Optional virtual size used for UI scale factor when main UI has none
      */
-    addUiRenderer(entity: Entity, ui: UiComponent): void;
+    addUiRenderer(entity: Entity, ui: UiComponent, options?: UiRendererOptions): void;
     /**
      * Remove a previously added UI renderer by its associated entity.
+     * It does not affect the main UI renderer.
      * @param entity - The entity whose UI renderer should be removed
      */
     removeUiRenderer(entity: Entity): void;
@@ -8150,6 +8158,14 @@ export declare interface UiLabelProps {
  */
 export declare type uint32 = number;
 
+/**
+ * @public
+ */
+export declare type UiRendererOptions = {
+    virtualWidth: number;
+    virtualHeight: number;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/dist/beta.d.ts

@@ -6898,8 +6898,14 @@ export declare type RaycastSystemOptions = {
  * @public
  */
 export declare interface ReactBasedUiSystem {
+    /**
+     * Destroy all UI entities and unregister related systems.
+     */
     destroy(): void;
-    setUiRenderer(ui: UiComponent): void;
+    /**
+     * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
+     */
+    setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
     /**
      * Add a UI renderer associated with an entity. The UI will be automatically cleaned up
      * when the entity is removed from the engine.
@@ -6912,10 +6918,12 @@ export declare interface ReactBasedUiSystem {
      * @param entity - The entity to associate with this UI renderer. When the entity is removed,
      *                 the UI renderer is automatically cleaned up.
      * @param ui - The UI component to render
+     * @param options - Optional virtual size used for UI scale factor when main UI has none
      */
-    addUiRenderer(entity: Entity, ui: UiComponent): void;
+    addUiRenderer(entity: Entity, ui: UiComponent, options?: UiRendererOptions): void;
     /**
      * Remove a previously added UI renderer by its associated entity.
+     * It does not affect the main UI renderer.
      * @param entity - The entity whose UI renderer should be removed
      */
     removeUiRenderer(entity: Entity): void;
@@ -8117,6 +8125,14 @@ export declare interface UiLabelProps {
  */
 export declare type uint32 = number;
 
+/**
+ * @public
+ */
+export declare type UiRendererOptions = {
+    virtualWidth: number;
+    virtualHeight: number;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/dist/index.bundled.d.ts

@@ -6898,8 +6898,14 @@ export declare type RaycastSystemOptions = {
  * @public
  */
 export declare interface ReactBasedUiSystem {
+    /**
+     * Destroy all UI entities and unregister related systems.
+     */
     destroy(): void;
-    setUiRenderer(ui: UiComponent): void;
+    /**
+     * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
+     */
+    setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
     /**
      * Add a UI renderer associated with an entity. The UI will be automatically cleaned up
      * when the entity is removed from the engine.
@@ -6912,10 +6918,12 @@ export declare interface ReactBasedUiSystem {
      * @param entity - The entity to associate with this UI renderer. When the entity is removed,
      *                 the UI renderer is automatically cleaned up.
      * @param ui - The UI component to render
+     * @param options - Optional virtual size used for UI scale factor when main UI has none
      */
-    addUiRenderer(entity: Entity, ui: UiComponent): void;
+    addUiRenderer(entity: Entity, ui: UiComponent, options?: UiRendererOptions): void;
     /**
      * Remove a previously added UI renderer by its associated entity.
+     * It does not affect the main UI renderer.
      * @param entity - The entity whose UI renderer should be removed
      */
     removeUiRenderer(entity: Entity): void;
@@ -8117,6 +8125,14 @@ export declare interface UiLabelProps {
  */
 export declare type uint32 = number;
 
+/**
+ * @public
+ */
+export declare type UiRendererOptions = {
+    virtualWidth: number;
+    virtualHeight: number;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;