@playcanvas/web-components 0.2.5 → 0.2.7

package/README.md

@@ -5,7 +5,7 @@
 [![License](https://img.shields.io/npm/l/@playcanvas/web-components.svg)](https://github.com/playcanvas/web-components/blob/main/LICENSE)
 [![GitHub Actions Build Status](https://github.com/playcanvas/web-components/actions/workflows/deploy.yml/badge.svg)](https://github.com/playcanvas/web-components/actions/workflows/deploy.yml)
 
-| [User Guide](https://developer.playcanvas.com/user-manual/engine/web-components) | [API Reference](https://api.playcanvas.com/modules/EngineWebComponents.html) | [Examples](https://playcanvas.github.io/web-components/examples) | [Blog](https://blog.playcanvas.com/) | [Forum](https://forum.playcanvas.com/) | [Discord](https://discord.gg/RSaMRzg) |
+| [User Guide](https://developer.playcanvas.com/user-manual/web-components) | [API Reference](https://api.playcanvas.com/web-components/) | [Examples](https://playcanvas.github.io/web-components/examples) | [Blog](https://blog.playcanvas.com/) | [Forum](https://forum.playcanvas.com/) | [Discord](https://discord.gg/RSaMRzg) |
 
 PlayCanvas Web Components are a set of custom HTML elements for building 3D interactive web apps. Using the declarative nature of HTML makes it both easy and fun to incorporate 3D into your website. Check out this simple example:
 

package/dist/app.d.ts

@@ -1,8 +1,8 @@
-import { Application } from 'playcanvas';
+import { AppBase } from 'playcanvas';
 import { AsyncElement } from './async-element';
 /**
  * The AppElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-app/ | `<pc-app>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/ | `<pc-app>`} elements.
  * The AppElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  */
@@ -12,6 +12,7 @@ declare class AppElement extends AsyncElement {
      */
     private _canvas;
     private _alpha;
+    private _backend;
     private _antialias;
     private _depth;
     private _stencil;
@@ -24,7 +25,7 @@ declare class AppElement extends AsyncElement {
     /**
      * The PlayCanvas application instance.
      */
-    app: Application | null;
+    app: AppBase | null;
     /**
      * Creates a new AppElement instance.
      *
@@ -62,6 +63,16 @@ declare class AppElement extends AsyncElement {
      * @returns The antialias flag.
      */
     get antialias(): boolean;
+    /**
+     * Sets the graphics backend.
+     * @param value - The graphics backend ('webgpu', 'webgl2', or 'null').
+     */
+    set backend(value: 'webgpu' | 'webgl2' | 'null');
+    /**
+     * Gets the graphics backend.
+     * @returns The graphics backend.
+     */
+    get backend(): "webgpu" | "webgl2" | "null";
     /**
      * Sets the depth flag.
      * @param value - The depth flag.

package/dist/asset.d.ts

@@ -1,7 +1,7 @@
 import { Asset } from 'playcanvas';
 /**
  * The AssetElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-asset/ | `<pc-asset>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-asset/ | `<pc-asset>`} elements.
  * The AssetElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  */

package/dist/components/camera-component.d.ts

@@ -2,7 +2,7 @@ import { CameraComponent, Color, Vec4 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The CameraComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-camera/ | `<pc-camera>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-camera/ | `<pc-camera>`} elements.
  * The CameraComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *
@@ -39,7 +39,7 @@ declare class CameraComponentElement extends ComponentElement {
         flipFaces: boolean;
         fov: number;
         frustumCulling: boolean;
-        gammaCorrection: number;
+        gammaCorrection: 0 | 1;
         horizontalFov: boolean;
         nearClip: number;
         orthographic: boolean;
@@ -47,7 +47,7 @@ declare class CameraComponentElement extends ComponentElement {
         priority: number;
         rect: Vec4;
         scissorRect: Vec4;
-        toneMapping: number | undefined;
+        toneMapping: 0 | 2 | 1 | 3 | 4 | 5 | 6 | undefined;
     };
     get xrAvailable(): boolean | null | undefined;
     /**

package/dist/components/collision-component.d.ts

@@ -2,7 +2,7 @@ import { CollisionComponent, Quat, Vec3 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The CollisionComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-collision/ | `<pc-collision>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-collision/ | `<pc-collision>`} elements.
  * The CollisionComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *

package/dist/components/element-component.d.ts

@@ -2,7 +2,7 @@ import { Color, ElementComponent, Vec2, Vec4 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The ElementComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-element/ | `<pc-element>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-element/ | `<pc-element>`} elements.
  * The ElementComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *

package/dist/components/light-component.d.ts

@@ -2,7 +2,7 @@ import { Color, LightComponent } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The LightComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-light/ | `<pc-light>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-light/ | `<pc-light>`} elements.
  * The LightComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *
@@ -38,7 +38,7 @@ declare class LightComponentElement extends ComponentElement {
         shadowDistance: number;
         shadowIntensity: number;
         shadowResolution: number;
-        shadowType: number | undefined;
+        shadowType: 0 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | undefined;
         type: string;
         vsmBias: number;
         vsmBlurSize: number;

package/dist/components/listener-component.d.ts

@@ -2,7 +2,7 @@ import { AudioListenerComponent } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The ListenerComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-listener/ | `<pc-listener>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-listener/ | `<pc-listener>`} elements.
  * The ListenerComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *

package/dist/components/particlesystem-component.d.ts

@@ -2,7 +2,7 @@ import { ParticleSystemComponent } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The ParticleSystemComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-particles/ | `<pc-particles>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-particles/ | `<pc-particles>`} elements.
  * The ParticleSystemComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *

package/dist/components/render-component.d.ts

@@ -2,7 +2,7 @@ import { RenderComponent, StandardMaterial } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The RenderComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-render/ | `<pc-render>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-render/ | `<pc-render>`} elements.
  * The RenderComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *

package/dist/components/rigidbody-component.d.ts

@@ -2,7 +2,7 @@ import { RigidBodyComponent, Vec3 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The RigidBodyComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-rigidbody/ | `<pc-rigidbody>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-rigidbody/ | `<pc-rigidbody>`} elements.
  * The RigidBodyComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *

package/dist/components/screen-component.d.ts

@@ -2,7 +2,7 @@ import { ScreenComponent, Vec2 } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The ScreenComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-screen/ | `<pc-screen>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-screen/ | `<pc-screen>`} elements.
  * The ScreenComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *
@@ -22,7 +22,7 @@ declare class ScreenComponentElement extends ComponentElement {
         referenceResolution: Vec2;
         resolution: Vec2;
         scaleBlend: number;
-        scaleMode: string;
+        scaleMode: "none" | "blend";
         screenSpace: boolean;
     };
     /**

package/dist/components/script-component.d.ts

@@ -18,7 +18,7 @@ declare global {
 }
 /**
  * The ScriptComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-scripts/ | `<pc-scripts>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-scripts/ | `<pc-scripts>`} elements.
  * The ScriptComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *

package/dist/components/sound-component.d.ts

@@ -2,7 +2,7 @@ import { SoundComponent } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The SoundComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-sounds/ | `<pc-sounds>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-sounds/ | `<pc-sounds>`} elements.
  * The SoundComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *

package/dist/components/splat-component.d.ts

@@ -2,7 +2,7 @@ import { GSplatComponent } from 'playcanvas';
 import { ComponentElement } from './component';
 /**
  * The SplatComponentElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-splat/ | `<pc-splat>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-splat/ | `<pc-splat>`} elements.
  * The SplatComponentElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  *
@@ -10,10 +10,12 @@ import { ComponentElement } from './component';
  */
 declare class SplatComponentElement extends ComponentElement {
     private _asset;
+    private _castShadows;
     /** @ignore */
     constructor();
     getInitialComponentData(): {
         asset: import("playcanvas").Asset | null | undefined;
+        castShadows: boolean;
     };
     /**
      * Gets the underlying PlayCanvas splat component.
@@ -30,6 +32,16 @@ declare class SplatComponentElement extends ComponentElement {
      * @returns The asset ID.
      */
     get asset(): string;
+    /**
+     * Sets whether the splat casts shadows.
+     * @param value - Whether the splat casts shadows.
+     */
+    set castShadows(value: boolean);
+    /**
+     * Gets whether the splat casts shadows.
+     * @returns Whether the splat casts shadows.
+     */
+    get castShadows(): boolean;
     static get observedAttributes(): string[];
     attributeChangedCallback(name: string, _oldValue: string, newValue: string): void;
 }

package/dist/entity.d.ts

@@ -1,8 +1,8 @@
-import { Application, Entity, Vec3 } from 'playcanvas';
+import { AppBase, Entity, Vec3 } from 'playcanvas';
 import { AsyncElement } from './async-element';
 /**
  * The EntityElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-entity/ | `<pc-entity>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-entity/ | `<pc-entity>`} elements.
  * The EntityElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  */
@@ -39,8 +39,8 @@ declare class EntityElement extends AsyncElement {
      * The PlayCanvas entity instance.
      */
     entity: Entity | null;
-    createEntity(app: Application): void;
-    buildHierarchy(app: Application): void;
+    createEntity(app: AppBase): void;
+    buildHierarchy(app: AppBase): void;
     connectedCallback(): void;
     disconnectedCallback(): void;
     /**

package/dist/material.d.ts

@@ -1,7 +1,7 @@
 import { Color, StandardMaterial } from 'playcanvas';
 /**
  * The MaterialElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-material/ | `<pc-material>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-material/ | `<pc-material>`} elements.
  * The MaterialElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  */

package/dist/model.d.ts

@@ -1,7 +1,7 @@
 import { AsyncElement } from './async-element';
 /**
  * The ModelElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-model/ | `<pc-model>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-model/ | `<pc-model>`} elements.
  * The ModelElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  */

package/dist/module.d.ts

@@ -1,6 +1,6 @@
 /**
  * The ModuleElement interface provides properties and methods for manipulating
- * {@link https://developer.playcanvas.com/user-manual/engine/web-components/tags/pc-module/ | `<pc-module>`} elements.
+ * {@link https://developer.playcanvas.com/user-manual/web-components/tags/pc-module/ | `<pc-module>`} elements.
  * The ModuleElement interface also inherits the properties and methods of the
  * {@link HTMLElement} interface.
  */