@expofp/renderer 1.4.1 → 1.5.0

package/dist/index.d.ts

@@ -2,6 +2,9 @@ import { default as default_2 } from 'stats-gl';
 import { Vector2 } from 'three';
 import { Vector2Like } from 'three';
 import { Vector2Tuple } from 'three';
+import { Vector3 } from 'three';
+import { Vector3Like } from 'three';
+import { Vector3Tuple } from 'three';
 import { WebGLRenderer } from 'three';
 
 /** Camera state returned by {@link ControlsAPI.getCameraState}. */
@@ -136,6 +139,13 @@ export declare interface ControlsAPI {
  */
 export declare function createVector2(vector2: IVector2): Vector2;
 
+/**
+ * Converts multiple vector3 representations to a {@link Vector3} instance.
+ * @param vector3 Vector3 representation as a tuple/POJO
+ * @returns Vector3 instance
+ */
+export declare function createVector3(vector3: IVector3 | IVector2): Vector3;
+
 /**
  * Mapping of engine-wide events to their payloads
  */
@@ -252,6 +262,8 @@ export declare function isTextLayer(layer: LayerDef): layer is TypedLayerDef<Tex
 
 export declare type IVector2 = Vector2 | Vector2Like | Vector2Tuple;
 
+export declare type IVector3 = Vector3 | Vector3Like | Vector3Tuple;
+
 /** Layer definition */
 export declare interface LayerDef extends SharedDef {
     /** Layer's name */
@@ -260,6 +272,8 @@ export declare interface LayerDef extends SharedDef {
     interactive?: boolean;
     /** Collection of layer's children. Mixing different types of children is not supported. */
     children: RenderableDefCollection;
+    /** Layer's rendering mode, 2d or 3d. Optional, 2d by default. */
+    mode?: "2d" | "3d";
 }
 
 /** Line definition */
@@ -303,14 +317,14 @@ export declare interface PitchHandlerOptions {
 /** Polygon shape instance. */
 export declare class Polygon {
     /** Array of polygon vertices. */
-    readonly vertices: Vector2[];
+    readonly vertices: Vector3[];
     /** Array of polygon indices. Each index is a triplet of vertex indices forming a triangle. */
     readonly indices: Index[];
     /**
      * @param vertices Array of polygon vertices.
      * @param indices Array of polygon indices. Each index is a triplet of vertex indices forming a triangle.
      */
-    constructor(vertices: IVector2[], indices: Index[]);
+    constructor(vertices: (IVector3 | IVector2)[], indices: Index[]);
     /**
      * Converts a {@link Rect} to a {@link Polygon}.
      * @param rect {@link Rect} instance
@@ -449,6 +463,14 @@ export declare class Renderer {
      * Main rendering loop
      */
     render(): void;
+    /**
+     * Stop the rendering loop
+     */
+    stop(): void;
+    /**
+     * Dispose all WebGL resources
+     */
+    dispose(): void;
     private resizeCanvasToDisplaySize;
     private updateMemoryInfo;
     private onContextLost;