@playcanvas/web-components 0.10.1 → 0.11.0

package/dist/sky.d.ts

@@ -10,7 +10,7 @@ declare class SkyElement extends AsyncElement {
     private _center;
     private _intensity;
     private _rotation;
-    private _level;
+    private _mipLevel;
     private _lighting;
     private _scale;
     private _type;
@@ -51,16 +51,6 @@ declare class SkyElement extends AsyncElement {
      * @returns The intensity.
      */
     get intensity(): number;
-    /**
-     * Sets the mip level of the skybox.
-     * @param value - The mip level.
-     */
-    set level(value: number);
-    /**
-     * Gets the mip level of the skybox.
-     * @returns The mip level.
-     */
-    get level(): number;
     /**
      * Sets whether the skybox is used as a light source.
      * @param value - Whether to use lighting.
@@ -71,6 +61,17 @@ declare class SkyElement extends AsyncElement {
      * @returns Whether to use lighting.
      */
     get lighting(): boolean;
+    /**
+     * Sets the mip level of the skybox, where 0 is the sharpest. Raising it selects a blurrier mip,
+     * which is how a skybox is softened without blurring the texture itself.
+     * @param value - The mip level.
+     */
+    set mipLevel(value: number);
+    /**
+     * Gets the mip level of the skybox.
+     * @returns The mip level.
+     */
+    get mipLevel(): number;
     /**
      * Sets the Euler rotation of the skybox.
      * @param value - The rotation.

package/dist/vscode.html-custom-data.json

@@ -4,12 +4,16 @@
   "tags": [
     {
       "name": "pc-app",
-      "description": "The AppElement interface provides properties and methods for manipulating\n[`<pc-app>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/) elements.\nThe AppElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **progress** - Fired while the application preloads its assets. `loaded` and `total` are asset counts, not bytes, and an asset that fails to load still counts as loaded. Fired at least once per boot, and the final event always has `loaded` equal to `total`. Does not bubble.\n- **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
+      "description": "The AppElement interface provides properties and methods for manipulating\n[`<pc-app>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/) elements.\nThe AppElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **progress** - Fired while the application preloads its assets. `loaded` and `total` are asset counts, not bytes, and an asset that fails to load still counts as loaded. Fired at least once per boot, and the final event always has `loaded` equal to `total`. Does not bubble.\n- **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n - **elementFromEntity(entity: _Entity_): __** - Returns the `<pc-entity>` element whose backing entity is `entity`, or `null` if the\nentity was not created by an element of this application - for example, a node inside a\nmodel's instantiated hierarchy, or an entity created through the engine API.\n\n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
       "attributes": [
-        { "name": "alpha", "description": "The alpha flag.", "values": [] },
+        {
+          "name": "alpha",
+          "description": "Whether the frame buffer has an alpha channel.",
+          "values": []
+        },
         {
           "name": "antialias",
-          "description": "The antialias flag.",
+          "description": "Whether the frame buffer is anti-aliased.",
           "values": []
         },
         {
@@ -21,10 +25,9 @@
             { "name": "null" }
           ]
         },
-        { "name": "depth", "description": "The depth flag.", "values": [] },
         {
-          "name": "high-resolution",
-          "description": "The high resolution flag.",
+          "name": "depth-buffer",
+          "description": "Whether the frame buffer has a depth buffer.",
           "values": []
         },
         {
@@ -32,7 +35,16 @@
           "description": "Whether the application shows its built-in loading bar while it boots and preloads its assets.",
           "values": []
         },
-        { "name": "stencil", "description": "The stencil flag.", "values": [] }
+        {
+          "name": "max-pixel-ratio",
+          "description": "The cap on the pixel ratio the application renders at.",
+          "values": []
+        },
+        {
+          "name": "stencil-buffer",
+          "description": "Whether the frame buffer has a stencil buffer.",
+          "values": []
+        }
       ],
       "references": []
     },
@@ -730,13 +742,13 @@
           "values": []
         },
         {
-          "name": "level",
-          "description": "The mip level of the skybox.",
+          "name": "lighting",
+          "description": "Whether the skybox is used as a light source.",
           "values": []
         },
         {
-          "name": "lighting",
-          "description": "Whether the skybox is used as a light source.",
+          "name": "mip-level",
+          "description": "The mip level of the skybox.",
           "values": []
         },
         {
@@ -918,16 +930,16 @@
           "description": "The orthographic height of the camera.",
           "values": []
         },
-        {
-          "name": "orthographic",
-          "description": "The orthographic projection of the camera.",
-          "values": []
-        },
         {
           "name": "priority",
           "description": "The priority of the camera.",
           "values": []
         },
+        {
+          "name": "projection",
+          "description": "The projection of the camera.",
+          "values": [{ "name": "perspective" }, { "name": "orthographic" }]
+        },
         {
           "name": "rect",
           "description": "The rect of the camera. Accepts 4 space-separated numbers.",
@@ -1528,7 +1540,6 @@
       "name": "pc-screen",
       "description": "The ScreenComponentElement interface provides properties and methods for manipulating\n[`<pc-screen>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-screen/) elements.\nThe ScreenComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
       "attributes": [
-        { "name": "blend", "values": [] },
         {
           "name": "enabled",
           "description": "The enabled state of the component.",
@@ -1545,7 +1556,16 @@
           "description": "Accepts 2 space-separated numbers.",
           "values": []
         },
-        { "name": "scale-blend", "values": [] },
+        {
+          "name": "scale-blend",
+          "description": "How the screen's resolutions are weighted against each other.",
+          "values": []
+        },
+        {
+          "name": "scale-mode",
+          "description": "How the screen scales its contents.",
+          "values": [{ "name": "none" }, { "name": "blend" }]
+        },
         { "name": "screen-space", "values": [] }
       ],
       "references": []
@@ -1638,7 +1658,7 @@
         { "name": "friction", "description": "The friction.", "values": [] },
         {
           "name": "horizontal",
-          "description": "Whether horizontal scrolling is enabled.",
+          "description": "Whether scrolling along the horizontal axis is enabled.",
           "values": []
         },
         {
@@ -1672,7 +1692,7 @@
         },
         {
           "name": "vertical",
-          "description": "Whether vertical scrolling is enabled.",
+          "description": "Whether scrolling along the vertical axis is enabled.",
           "values": []
         },
         {

package/dist/web-types.json

@@ -1,24 +1,24 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@playcanvas/web-components",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "name": "pc-app",
-          "description": "The AppElement interface provides properties and methods for manipulating\n[`<pc-app>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/) elements.\nThe AppElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **progress** - Fired while the application preloads its assets. `loaded` and `total` are asset counts, not bytes, and an asset that fails to load still counts as loaded. Fired at least once per boot, and the final event always has `loaded` equal to `total`. Does not bubble.\n- **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
+          "description": "The AppElement interface provides properties and methods for manipulating\n[`<pc-app>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-app/) elements.\nThe AppElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **progress** - Fired while the application preloads its assets. `loaded` and `total` are asset counts, not bytes, and an asset that fails to load still counts as loaded. Fired at least once per boot, and the final event always has `loaded` equal to `total`. Does not bubble.\n- **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n - **elementFromEntity(entity: _Entity_): __** - Returns the `<pc-entity>` element whose backing entity is `entity`, or `null` if the\nentity was not created by an element of this application - for example, a node inside a\nmodel's instantiated hierarchy, or an entity created through the engine API.\n\n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
           "doc-url": "",
           "attributes": [
             {
               "name": "alpha",
-              "description": "The alpha flag.",
+              "description": "Whether the frame buffer has an alpha channel.",
               "value": { "type": "boolean", "default": "true" }
             },
             {
               "name": "antialias",
-              "description": "The antialias flag.",
+              "description": "Whether the frame buffer is anti-aliased.",
               "value": { "type": "boolean", "default": "true" }
             },
             {
@@ -30,13 +30,8 @@
               }
             },
             {
-              "name": "depth",
-              "description": "The depth flag.",
-              "value": { "type": "boolean", "default": "true" }
-            },
-            {
-              "name": "high-resolution",
-              "description": "The high resolution flag.",
+              "name": "depth-buffer",
+              "description": "Whether the frame buffer has a depth buffer.",
               "value": { "type": "boolean", "default": "true" }
             },
             {
@@ -45,8 +40,13 @@
               "value": { "type": "boolean", "default": "true" }
             },
             {
-              "name": "stencil",
-              "description": "The stencil flag.",
+              "name": "max-pixel-ratio",
+              "description": "The cap on the pixel ratio the application renders at.",
+              "value": { "type": "number", "default": "Infinity" }
+            },
+            {
+              "name": "stencil-buffer",
+              "description": "Whether the frame buffer has a stencil buffer.",
               "value": { "type": "boolean", "default": "true" }
             }
           ],
@@ -74,25 +74,34 @@
                 "description": "The asset preload progress of the application, as a fraction from 0 to 1. It is 0 until\npreloading begins (and again once the element has been removed from the document), and 1\nonce preloading has finished — including when there was nothing to preload. Read this to\ninitialize a loading UI; subsequent updates arrive via the `progress` event.",
                 "type": "number"
               },
-              { "name": "alpha", "description": "Gets the alpha flag." },
+              {
+                "name": "alpha",
+                "description": "Gets whether the frame buffer has an alpha channel."
+              },
               {
                 "name": "antialias",
-                "description": "Gets the antialias flag."
+                "description": "Gets whether the frame buffer is anti-aliased."
               },
               {
                 "name": "backend",
                 "description": "Gets the graphics backend."
               },
-              { "name": "depth", "description": "Gets the depth flag." },
               {
-                "name": "highResolution",
-                "description": "Gets the high resolution flag."
+                "name": "depthBuffer",
+                "description": "Gets whether the frame buffer has a depth buffer."
               },
               {
                 "name": "loadingBar",
                 "description": "Gets whether the application shows its built-in loading bar while it boots and preloads\nits assets."
               },
-              { "name": "stencil", "description": "Gets the stencil flag." },
+              {
+                "name": "maxPixelRatio",
+                "description": "Gets the cap on the pixel ratio the application renders at."
+              },
+              {
+                "name": "stencilBuffer",
+                "description": "Gets whether the frame buffer has a stencil buffer."
+              },
               {
                 "name": "closestApp",
                 "description": "The nearest ancestor `<pc-app>` element, or `null` if this element has no `<pc-app>`\nancestor. The search starts at the parent, so an element never resolves to itself.",
@@ -1361,16 +1370,16 @@
               "description": "The intensity of the skybox.",
               "value": { "type": "number", "default": "1" }
             },
-            {
-              "name": "level",
-              "description": "The mip level of the skybox.",
-              "value": { "type": "number", "default": "0" }
-            },
             {
               "name": "lighting",
               "description": "Whether the skybox is used as a light source.",
               "value": { "type": "boolean", "default": "false" }
             },
+            {
+              "name": "mip-level",
+              "description": "The mip level of the skybox.",
+              "value": { "type": "number", "default": "0" }
+            },
             {
               "name": "rotation",
               "description": "The Euler rotation of the skybox. Accepts 3 space-separated numbers.",
@@ -1411,14 +1420,14 @@
                 "name": "intensity",
                 "description": "Gets the intensity of the skybox."
               },
-              {
-                "name": "level",
-                "description": "Gets the mip level of the skybox."
-              },
               {
                 "name": "lighting",
                 "description": "Gets whether the skybox is used as a light source."
               },
+              {
+                "name": "mipLevel",
+                "description": "Gets the mip level of the skybox."
+              },
               {
                 "name": "rotation",
                 "description": "Gets the Euler rotation of the skybox."
@@ -1698,16 +1707,19 @@
               "description": "The orthographic height of the camera.",
               "value": { "type": "number", "default": "10" }
             },
-            {
-              "name": "orthographic",
-              "description": "The orthographic projection of the camera.",
-              "value": { "type": "boolean", "default": "false" }
-            },
             {
               "name": "priority",
               "description": "The priority of the camera.",
               "value": { "type": "number", "default": "0" }
             },
+            {
+              "name": "projection",
+              "description": "The projection of the camera.",
+              "value": {
+                "type": "'perspective' | 'orthographic'",
+                "default": "perspective"
+              }
+            },
             {
               "name": "rect",
               "description": "The rect of the camera. Accepts 4 space-separated numbers.",
@@ -1802,11 +1814,6 @@
                 "description": "Gets the near clip distance of the camera.",
                 "type": "number"
               },
-              {
-                "name": "orthographic",
-                "description": "Gets the orthographic projection of the camera.",
-                "type": "boolean"
-              },
               {
                 "name": "orthoHeight",
                 "description": "Gets the orthographic height of the camera."
@@ -1816,6 +1823,10 @@
                 "description": "Gets the priority of the camera.",
                 "type": "number"
               },
+              {
+                "name": "projection",
+                "description": "Gets the projection of the camera."
+              },
               {
                 "name": "rect",
                 "description": "Gets the rect of the camera.",
@@ -3108,10 +3119,6 @@
           "description": "The ScreenComponentElement interface provides properties and methods for manipulating\n[`<pc-screen>`](https://developer.playcanvas.com/user-manual/web-components/tags/pc-screen/) elements.\nThe ScreenComponentElement interface also inherits the properties and methods of the\nHTMLElement interface.\n\n---\n\n\n### **Events:**\n - **ready** - Fired once the element is fully initialized. Bubbles and is composed.\n\n### **Methods:**\n \n- **ready(): __** - Returns a promise that resolves with this element when it's ready. This is the low-level\nprimitive underlying whenReady, which is the recommended way to wait for elements.",
           "doc-url": "",
           "attributes": [
-            {
-              "name": "blend",
-              "value": { "type": "boolean", "default": "false" }
-            },
             {
               "name": "enabled",
               "description": "The enabled state of the component.",
@@ -3133,8 +3140,14 @@
             },
             {
               "name": "scale-blend",
+              "description": "How the screen's resolutions are weighted against each other.",
               "value": { "type": "number", "default": "0.5" }
             },
+            {
+              "name": "scale-mode",
+              "description": "How the screen scales its contents.",
+              "value": { "type": "'none' | 'blend'", "default": "none" }
+            },
             {
               "name": "screen-space",
               "value": { "type": "boolean", "default": "false" }
@@ -3157,8 +3170,14 @@
               { "name": "priority" },
               { "name": "referenceResolution" },
               { "name": "resolution" },
-              { "name": "scaleBlend" },
-              { "name": "blend" },
+              {
+                "name": "scaleBlend",
+                "description": "Gets how the screen's resolutions are weighted against each other."
+              },
+              {
+                "name": "scaleMode",
+                "description": "Gets how the screen scales its contents."
+              },
               { "name": "screenSpace" },
               {
                 "name": "enabled",
@@ -3443,7 +3462,7 @@
             },
             {
               "name": "horizontal",
-              "description": "Whether horizontal scrolling is enabled.",
+              "description": "Whether scrolling along the horizontal axis is enabled.",
               "value": { "type": "boolean", "default": "true" }
             },
             {
@@ -3479,7 +3498,7 @@
             },
             {
               "name": "vertical",
-              "description": "Whether vertical scrolling is enabled.",
+              "description": "Whether scrolling along the vertical axis is enabled.",
               "value": { "type": "boolean", "default": "true" }
             },
             {
@@ -3517,11 +3536,11 @@
               },
               {
                 "name": "horizontal",
-                "description": "Gets whether horizontal scrolling is enabled."
+                "description": "Gets whether scrolling along the horizontal axis is enabled."
               },
               {
                 "name": "vertical",
-                "description": "Gets whether vertical scrolling is enabled."
+                "description": "Gets whether scrolling along the vertical axis is enabled."
               },
               {
                 "name": "scrollMode",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playcanvas/web-components",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "author": "PlayCanvas <support@playcanvas.com>",
   "homepage": "https://playcanvas.com",
   "description": "Web Components for the PlayCanvas Engine",