@babylonjs/lite-compat 1.16.0-preview → 1.17.0-preview

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -123,7 +123,7 @@ overloads within a supported area may still be absent.
123
123
  | Cameras (`ArcRotateCamera`, `FreeCamera`/`Universal`/`Target`, `FollowCamera`, `GeospatialCamera`) | ✅ | XR / device-orientation / stereoscopic rigs unsupported |
124
124
  | Lights (`Hemispheric`, `Directional`, `Point`, `Spot`) | ✅ | `RectAreaLight` / clustered lights unsupported |
125
125
  | Shadows (`ShadowGenerator` directional ESM/PCF, spot PCF) | ⚡ | `CascadedShadowGenerator` falls back to single cascade |
126
- | Meshes & geometry (class chain, `MeshBuilder` primitives, transforms, thin instances, `clone`, `VertexData`, `Mesh.MergeMeshes`) | ⚡ | `MergeMeshes` bakes positions/normals/UVs and rejects unsupported attributes/animation; `CreateLines`/`CreateDecal`/`CreateText`/`CreateTiledBox`/`CreateTiledPlane`, `InstancedMesh`, LOD/edges/outline, hardware instances unsupported |
126
+ | Meshes & geometry (class chain, `MeshBuilder` primitives, transforms, thin instances, `clone`, `VertexData`, `Mesh.MergeMeshes`) | ⚡ | `CreateLines`/`CreateLineSystem` support fixed-topology line lists and RGBA point colors; `MergeMeshes` bakes positions/normals/UVs and rejects unsupported attributes/animation; `CreateDashedLines`/`CreateDecal`/`CreateText`/`CreateTiledBox`/`CreateTiledPlane`, `InstancedMesh`, LOD/edges/outline, hardware instances unsupported |
127
127
  | CSG / CSG2 | ✅ | over Lite boolean ops |
128
128
  | Gizmos (position/rotation/scale/bounding-box/light/camera + `GizmoManager`) | ⚡ | over Lite gizmo suite; `isEnabled` toggles per-axis interactivity (display-only when disabled) |
129
129
  | Materials (`StandardMaterial`, `PBRMaterial`, metallic-rough / spec-gloss, `NodeMaterial`) | ⚡ | `clone(name)` shares textures with its own renderable; `ShaderMaterial` (GLSL), `MultiMaterial`, `BackgroundMaterial` unsupported |
package/index.d.ts CHANGED
@@ -6,6 +6,7 @@ import { ClearCoatProps } from '@babylonjs/lite';
6
6
  import { EngineContext } from '@babylonjs/lite';
7
7
  import { EngineOptions } from '@babylonjs/lite';
8
8
  import { IridescenceProps } from '@babylonjs/lite';
9
+ import { LineMaterial } from '@babylonjs/lite';
9
10
  import { Mesh as Mesh_2 } from '@babylonjs/lite';
10
11
  import { PhysicsWorld } from '@babylonjs/lite';
11
12
  import { RenderCanvas } from '@babylonjs/lite';
@@ -1235,7 +1236,7 @@ export declare class ColorGradient {
1235
1236
  constructor(gradient: number, color1: [number, number, number, number], color2?: [number, number, number, number] | undefined);
1236
1237
  }
1237
1238
 
1238
- declare type CompatMaterial = StandardMaterial | PBRMaterial | NodeMaterial | GridMaterial;
1239
+ declare type CompatMaterial = StandardMaterial | PBRMaterial | NodeMaterial | GridMaterial | LinesMaterial;
1239
1240
 
1240
1241
  declare type CompatMaterial_2 = StandardMaterial | PBRMaterial | NodeMaterial;
1241
1242
 
@@ -1294,6 +1295,12 @@ export declare function CreateDisc(name: string, options: object, scene: Scene):
1294
1295
  /** Babylon.js `CreateGround(name, options, scene)` (groundBuilder). */
1295
1296
  export declare function CreateGround(name: string, options: GroundOptions, scene: Scene): Mesh;
1296
1297
 
1298
+ /** Babylon.js `CreateLines(name, options, scene)` (linesBuilder). */
1299
+ export declare function CreateLines(name: string, options: LinesBuilderOptions, scene?: Scene | null): LinesMesh;
1300
+
1301
+ /** Babylon.js `CreateLineSystem(name, options, scene)` (linesBuilder). */
1302
+ export declare function CreateLineSystem(name: string, options: LineSystemBuilderOptions, scene?: Scene | null): LinesMesh;
1303
+
1297
1304
  /** Babylon.js `CreateMainAudioBusAsync`. */
1298
1305
  export declare function CreateMainAudioBusAsync(name: string, options?: Partial<IMainAudioBusOptions>, engine?: AudioEngineV2 | null): Promise<MainAudioBus>;
1299
1306
 
@@ -1407,19 +1414,21 @@ export declare class CSG2 {
1407
1414
  * actual GPU work happens when it is assigned to `scene.environmentTexture` and
1408
1415
  * the engine starts (see `Scene` env handling).
1409
1416
  */
1410
- export declare class CubeTexture {
1417
+ export declare class CubeTexture extends BaseTexture {
1411
1418
  /** Source URL of the (prefiltered) environment. */
1412
1419
  readonly url: string;
1413
1420
  /** Babylon.js `coordinatesMode` (skybox = 5). Recorded for API parity. */
1414
1421
  coordinatesMode: number;
1415
- name: string;
1416
1422
  gammaSpace: boolean;
1417
1423
  level: number;
1418
1424
  /** Fires when the cube map is "ready" (resolved on a microtask in this compat layer). */
1419
1425
  readonly onLoadObservable: Observable<CubeTexture>;
1420
1426
  private _ready;
1427
+ private readonly _readyPromise;
1421
1428
  constructor(url: string, _scene?: unknown, _extensions?: unknown, _noMipmap?: boolean, _files?: unknown, onLoad?: (() => void) | null, _onError?: unknown, _format?: unknown, _prefiltered?: boolean);
1429
+ getClassName(): string;
1422
1430
  /** Babylon.js `BaseTexture.isReady()`. */
1423
1431
  isReady(): boolean;
1432
+ whenReadyAsync(): Promise<void>;
1424
1433
  /** Babylon.js `CubeTexture.CreateFromPrefilteredData(url, scene)`. */
1425
1434
  static CreateFromPrefilteredData(url: string, scene?: unknown): CubeTexture;
1426
1435
  dispose(): void;
@@ -1924,21 +1933,23 @@ export declare class HavokPlugin {
1924
1933
  * `scene.environmentTexture` and the engine starts, at which point the scene
1925
1934
  * routes it through Babylon Lite's native `loadHdrEnvironment`.
1926
1935
  */
1927
- export declare class HDRCubeTexture {
1936
+ export declare class HDRCubeTexture extends BaseTexture {
1928
1937
  /** Source URL of the `.hdr` panorama. */
1929
1938
  readonly url: string;
1930
1939
  /** Requested cubemap face size (BJS `size`); forwarded to Lite's `faceSize`. */
1931
1940
  readonly size: number;
1932
1941
  /** Babylon.js `coordinatesMode` (skybox = 5). Recorded for API parity. */
1933
1942
  coordinatesMode: number;
1934
- name: string;
1935
1943
  gammaSpace: boolean;
1936
1944
  level: number;
1937
1945
  /** Fires when the HDR environment is "ready" (resolved on a microtask). */
1938
1946
  readonly onLoadObservable: Observable<HDRCubeTexture>;
1939
1947
  private _ready;
1948
+ private readonly _readyPromise;
1940
1949
  constructor(url: string, _sceneOrEngine?: unknown, size?: number, _noMipmap?: boolean, _generateHarmonics?: boolean, _gammaSpace?: boolean, _prefilterOnLoad?: boolean, onLoad?: (() => void) | null);
1950
+ getClassName(): string;
1941
1951
  /** Babylon.js `BaseTexture.isReady()`. */
1942
1952
  isReady(): boolean;
1953
+ whenReadyAsync(): Promise<void>;
1943
1954
  dispose(): void;
1944
1955
  }
1945
1956
 
@@ -2361,8 +2372,49 @@ export declare class LightGizmo {
2361
2372
  private _attached;
2362
2373
  dispose(): void;
2363
2374
  }
2364
2375
 
2365
- export declare class LinesMesh {
2366
- constructor();
2376
+ declare interface LinesBuilderOptions {
2377
+ points: Vector3[];
2378
+ updatable?: boolean;
2379
+ instance?: LinesMesh | null;
2380
+ colors?: Color4[];
2381
+ useVertexAlpha?: boolean;
2382
+ material?: unknown;
2383
+ }
2384
+
2385
+ declare class LinesMaterial extends Material {
2386
+ readonly _lite: LineMaterial;
2387
+ constructor(name: string, lite: LineMaterial, scene?: Scene);
2388
+ getClassName(): string;
2389
+ clone(name: string): LinesMaterial;
2390
+ }
2391
+
2392
+ /** Babylon.js `LinesMesh` backed by a Babylon Lite line-system mesh. */
2393
+ export declare class LinesMesh extends Mesh {
2394
+ readonly useVertexColor: boolean;
2395
+ readonly useVertexAlpha: boolean;
2396
+ intersectionThreshold: number;
2397
+ private _lineMaterial;
2398
+ private readonly _color;
2399
+ private _alpha;
2400
+ private _suspendLineColorSync;
2401
+ constructor(name: string, sceneOrLite: Scene | Mesh_2, scene?: Scene, useVertexColor?: boolean, useVertexAlpha?: boolean);
2402
+ getClassName(): string;
2403
+ get color(): Color3;
2404
+ set color(value: Color3);
2405
+ get alpha(): number;
2406
+ set alpha(value: number);
2407
+ thinInstanceSetBuffer(kind: string, buffer: Float32Array | null, stride?: number): void;
2408
+ private _enableThinLineMaterial;
2409
+ private _syncLineColor;
2410
+ }
2411
+
2412
+ declare interface LineSystemBuilderOptions {
2413
+ lines: Vector3[][];
2414
+ updatable?: boolean;
2415
+ instance?: LinesMesh | null;
2416
+ colors?: Color4[][] | null;
2417
+ useVertexAlpha?: boolean;
2418
+ material?: unknown;
2367
2419
  }
2368
2420
 
2369
2421
  /**
@@ -2594,8 +2646,8 @@ export declare const MeshBuilder: {
2594
2646
  CreateRibbon(name: string, options: object, scene: Scene): Mesh;
2595
2647
  CreateTube(name: string, options: object, scene: Scene): Mesh;
2596
2648
  ExtrudeShape(name: string, options: object, scene: Scene): Mesh;
2597
- CreateLines(): never;
2598
- CreateLineSystem(): never;
2649
+ CreateLines(name: string, options: LinesBuilderOptions, scene?: Scene | null): LinesMesh;
2650
+ CreateLineSystem(name: string, options: LineSystemBuilderOptions, scene?: Scene | null): LinesMesh;
2599
2651
  CreateDashedLines(): never;
2600
2652
  CreateDecal(): never;
2601
2653
  CreateText(): never;