playcanvas 1.50.1 → 1.51.0

package/build/playcanvas-extras.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * PlayCanvas Engine v1.50.1 revision 1f42a385f
+ * PlayCanvas Engine v1.51.0 revision 094433dc7
  * Copyright 2011-2021 PlayCanvas Ltd. All rights reserved.
  */
 (function (global, factory) {

package/build/playcanvas.d.ts

@@ -1724,13 +1724,13 @@ export class AnimComponentLayer {
      */
     assignMask(mask?: any): void;
     /**
-     * Assigns an animation track to a state in the current graph. If a state for the given nodeName doesn't exist, it will be created. If all states nodes are linked and the {@link AnimComponent#activate} value was set to true then the component will begin playing.
-     * @param nodeName - The name of the node that this animation should be associated with.
+     * Assigns an animation track to a state or blend tree node in the current graph. If a state for the given nodePath doesn't exist, it will be created. If all states nodes are linked and the {@link AnimComponent#activate} value was set to true then the component will begin playing.
+     * @param nodePath - Either the state name or the path to a blend tree node that this animation should be associated with. Each section of a blend tree path is split using a period (`.`) therefore state names should not include this character (e.g "MyStateName" or "MyStateName.BlendTreeNode").
      * @param animTrack - The animation track that will be assigned to this state and played whenever this state is active.
      * @param [speed] - Update the speed of the state you are assigning an animation to. Defaults to 1.
      * @param [loop] - Update the loop property of the state you are assigning an animation to. Defaults to true.
      */
-    assignAnimation(nodeName: string, animTrack: any, speed?: number, loop?: boolean): void;
+    assignAnimation(nodePath: string, animTrack: any, speed?: number, loop?: boolean): void;
     /**
      * Removes animations from a node in the loaded state graph.
      * @param nodeName - The name of the node that should have its animation tracks removed.
@@ -1875,15 +1875,15 @@ export class AnimComponent extends Component {
      */
     findAnimationLayer(name: string): AnimComponentLayer;
     /**
-     * Associates an animation with a state in the loaded state graph. If all states are linked and the {@link AnimComponent#activate} value was set to true then the component will begin playing.
-     * If no state graph is loaded, a default state graph will be created with a single state based on the provided nodeName parameter.
-     * @param nodeName - The name of the state node that this animation should be associated with.
+     * Associates an animation with a state or blend tree node in the loaded state graph. If all states are linked and the {@link AnimComponent#activate} value was set to true then the component will begin playing.
+     * If no state graph is loaded, a default state graph will be created with a single state based on the provided nodePath parameter.
+     * @param nodePath - Either the state name or the path to a blend tree node that this animation should be associated with. Each section of a blend tree path is split using a period (`.`) therefore state names should not include this character (e.g "MyStateName" or "MyStateName.BlendTreeNode").
      * @param animTrack - The animation track that will be assigned to this state and played whenever this state is active.
      * @param [layerName] - The name of the anim component layer to update. If omitted the default layer is used. If no state graph has been previously loaded this parameter is ignored.
      * @param [speed] - Update the speed of the state you are assigning an animation to. Defaults to 1.
      * @param [loop] - Update the loop property of the state you are assigning an animation to. Defaults to true.
      */
-    assignAnimation(nodeName: string, animTrack: any, layerName?: string, speed?: number, loop?: boolean): void;
+    assignAnimation(nodePath: string, animTrack: any, layerName?: string, speed?: number, loop?: boolean): void;
     /**
      * Removes animations from a node in the loaded state graph.
      * @param nodeName - The name of the node that should have its animation tracks removed.
@@ -2246,6 +2246,8 @@ LAYERID_SKYBOX, LAYERID_UI, LAYERID_IMMEDIATE].
  * @property disablePostEffectsLayer - Layer ID of a layer on which the postprocessing of the camera stops being applied to.
 Defaults to LAYERID_UI, which causes post processing to not be applied to UI layer and
 any following layers for the camera. Set to undefined for post-processing to be applied to all layers of the camera.
+ * @property onPreRender - Custom function that is called before the camera renders the scene.
+ * @property onPostRender - Custom function that is called after the camera renders the scene.
  * @param system - The ComponentSystem that created this
 Component.
  * @param entity - The Entity that this Component is attached to.
@@ -2514,6 +2516,14 @@ export class CameraComponent extends Component {
      * any following layers for the camera. Set to undefined for post-processing to be applied to all layers of the camera.
     */
     disablePostEffectsLayer: number;
+    /**
+     * Custom function that is called before the camera renders the scene.
+    */
+    onPreRender: (...params: any[]) => any;
+    /**
+     * Custom function that is called after the camera renders the scene.
+    */
+    onPostRender: (...params: any[]) => any;
 }
 
 /**
@@ -7352,12 +7362,6 @@ export class PostEffect {
  */
 export function drawFullscreenQuad(device: GraphicsDevice, target: RenderTarget, vertexBuffer: VertexBuffer, shader: Shader, rect?: Vec4): void;
 
-/**
- * Prefilter a cubemap for use by a {@link StandardMaterial} as an environment map. Should only be used for cubemaps that can't be prefiltered ahead of time (in the editor).
- * @param options - The options for how the cubemap is prefiltered.
- */
-export function prefilterCubemap(options: any): void;
-
 /**
  * Object containing all default shader chunks used by shader generators.
  */
@@ -7489,11 +7493,17 @@ export class RenderTarget {
  * the function performs a standard resample.
  * @param [options.numSamples] - Optional number of samples (default is 1024).
  * @param [options.face] - Optional cubemap face to update (default is update all faces).
+ * @param [options.distribution] - Specify convolution distribution - 'none', 'lambert', 'phong', 'ggx'. Default depends on specularPower.
+ * @param [options.rect] - Optional viewport rectangle.
+ * @param [options.seamPixels] - Optional number of seam pixels to render
  */
 export function reprojectTexture(source: Texture, target: Texture, options?: {
     specularPower?: number;
     numSamples?: number;
     face?: number;
+    distribution?: string;
+    rect?: Vec4;
+    seamPixels?: number;
 }): void;
 
 /**
@@ -8265,13 +8275,13 @@ export class VertexIterator {
      * Moves the vertex iterator on to the next vertex.
      * @example
      * var iterator = new pc.VertexIterator(vertexBuffer);
-    iterator.element[pc.SEMANTIC_POSTIION].set(-0.9, -0.9, 0.0);
+    iterator.element[pc.SEMANTIC_POSITION].set(-0.9, -0.9, 0.0);
     iterator.element[pc.SEMANTIC_COLOR].set(255, 0, 0, 255);
     iterator.next();
-    iterator.element[pc.SEMANTIC_POSTIION].set(0.9, -0.9, 0.0);
+    iterator.element[pc.SEMANTIC_POSITION].set(0.9, -0.9, 0.0);
     iterator.element[pc.SEMANTIC_COLOR].set(0, 255, 0, 255);
     iterator.next();
-    iterator.element[pc.SEMANTIC_POSTIION].set(0.0, 0.9, 0.0);
+    iterator.element[pc.SEMANTIC_POSITION].set(0.0, 0.9, 0.0);
     iterator.element[pc.SEMANTIC_COLOR].set(0, 0, 255, 255);
     iterator.end();
      * @param [count] - Optional number of steps to move on when calling next. Defaults to 1.
@@ -8282,13 +8292,13 @@ export class VertexIterator {
     the vertex buffer is unlocked and vertex data is uploaded to video memory.
      * @example
      * var iterator = new pc.VertexIterator(vertexBuffer);
-    iterator.element[pc.SEMANTIC_POSTIION].set(-0.9, -0.9, 0.0);
+    iterator.element[pc.SEMANTIC_POSITION].set(-0.9, -0.9, 0.0);
     iterator.element[pc.SEMANTIC_COLOR].set(255, 0, 0, 255);
     iterator.next();
-    iterator.element[pc.SEMANTIC_POSTIION].set(0.9, -0.9, 0.0);
+    iterator.element[pc.SEMANTIC_POSITION].set(0.9, -0.9, 0.0);
     iterator.element[pc.SEMANTIC_COLOR].set(0, 255, 0, 255);
     iterator.next();
-    iterator.element[pc.SEMANTIC_POSTIION].set(0.0, 0.9, 0.0);
+    iterator.element[pc.SEMANTIC_POSITION].set(0.0, 0.9, 0.0);
     iterator.element[pc.SEMANTIC_COLOR].set(0, 0, 255, 255);
     iterator.end();
      */
@@ -13320,6 +13330,11 @@ export const SHADOW_VSM32: number;
  */
 export const SHADOW_PCF5: number;
 
+/**
+ * Render depth (color-packed on WebGL 1.0), can be used for PCF 1x1 sampling.
+ */
+export const SHADOW_PCF1: number;
+
 /**
  * Box filter.
  */
@@ -14927,15 +14942,9 @@ export class Material {
  * - alphaFade: fade value. See {@link Material#alphaFade}.
  * - sphereMap: if {@link StandardMaterial#sphereMap} is used.
  * - cubeMap: if {@link StandardMaterial#cubeMap} is used.
- * - dpAtlas: if dual-paraboloid reflection is used. Dual paraboloid reflections replace prefiltered cubemaps on certain platform (mostly Android) for performance reasons.
  * - ambientSH: if ambient spherical harmonics are used. Ambient SH replace prefiltered cubemap ambient on certain platform (mostly Android) for performance reasons.
  * - useSpecular: if any specular or reflections are needed at all.
- * - rgbmAmbient: if ambient cubemap or spherical harmonics are RGBM-encoded.
- * - hdrAmbient: if ambient cubemap or spherical harmonics are plain float HDR data.
- * - rgbmReflection: if reflection cubemap or dual paraboloid are RGBM-encoded.
- * - hdrReflection: if reflection cubemap or dual paraboloid are plain float HDR data.
  * - fixSeams: if cubemaps require seam fixing (see {@link Texture#options.fixCubemapSeams}).
- * - prefilteredCubemap: if prefiltered cubemaps are used.
  * - emissiveFormat: how emissiveMap must be sampled. This value is based on {@link Texture#options.rgbm} and {@link Texture#options.format}. Possible values are:
  *   - 0: sRGB texture
  *   - 1: RGBM-encoded HDR texture
@@ -14951,11 +14960,13 @@ export class Material {
  * - refraction: if refraction is used.
  * - skyboxIntensity: if reflected skybox intensity should be modulated.
  * - useCubeMapRotation: if cube map rotation is enabled.
- * - useRightHandedCubeMap: if the cube map uses a right-handed coordinate system. The convention for pre-generated cubemaps is left-handed.
- * - useTexCubeLod: if textureCubeLodEXT function should be used to read prefiltered cubemaps. Usually true of iOS, false on other devices due to quality/performance balance.
  * - useInstancing: if hardware instancing compatible shader should be generated. Transform is read from per-instance {@link VertexBuffer} instead of shader's uniforms.
  * - useMorphPosition: if morphing code should be generated to morph positions.
  * - useMorphNormal: if morphing code should be generated to morph normals.
+ * - reflectionSource: one of "envAtlas", "cubeMap", "sphereMap"
+ * - reflectionEncoding: one of null, "rgbm", "rgbe", "linear", "srgb"
+ * - ambientSource: one of "ambientSH", "envAtlas", "constant"
+ * - ambientEncoding: one of null, "rgbm", "rgbe", "linear", "srgb"
  */
 export class StandardMaterial extends Material {
     /**
@@ -15660,15 +15671,9 @@ export class StandardMaterial extends Material {
     - alphaFade: fade value. See {@link Material#alphaFade}.
     - sphereMap: if {@link StandardMaterial#sphereMap} is used.
     - cubeMap: if {@link StandardMaterial#cubeMap} is used.
-    - dpAtlas: if dual-paraboloid reflection is used. Dual paraboloid reflections replace prefiltered cubemaps on certain platform (mostly Android) for performance reasons.
     - ambientSH: if ambient spherical harmonics are used. Ambient SH replace prefiltered cubemap ambient on certain platform (mostly Android) for performance reasons.
     - useSpecular: if any specular or reflections are needed at all.
-    - rgbmAmbient: if ambient cubemap or spherical harmonics are RGBM-encoded.
-    - hdrAmbient: if ambient cubemap or spherical harmonics are plain float HDR data.
-    - rgbmReflection: if reflection cubemap or dual paraboloid are RGBM-encoded.
-    - hdrReflection: if reflection cubemap or dual paraboloid are plain float HDR data.
     - fixSeams: if cubemaps require seam fixing (see {@link Texture#options.fixCubemapSeams}).
-    - prefilteredCubemap: if prefiltered cubemaps are used.
     - emissiveFormat: how emissiveMap must be sampled. This value is based on {@link Texture#options.rgbm} and {@link Texture#options.format}. Possible values are:
       - 0: sRGB texture
       - 1: RGBM-encoded HDR texture
@@ -15684,11 +15689,13 @@ export class StandardMaterial extends Material {
     - refraction: if refraction is used.
     - skyboxIntensity: if reflected skybox intensity should be modulated.
     - useCubeMapRotation: if cube map rotation is enabled.
-    - useRightHandedCubeMap: if the cube map uses a right-handed coordinate system. The convention for pre-generated cubemaps is left-handed.
-    - useTexCubeLod: if textureCubeLodEXT function should be used to read prefiltered cubemaps. Usually true of iOS, false on other devices due to quality/performance balance.
     - useInstancing: if hardware instancing compatible shader should be generated. Transform is read from per-instance {@link VertexBuffer} instead of shader's uniforms.
     - useMorphPosition: if morphing code should be generated to morph positions.
     - useMorphNormal: if morphing code should be generated to morph normals.
+    - reflectionSource: one of "envAtlas", "cubeMap", "sphereMap"
+    - reflectionEncoding: one of null, "rgbm", "rgbe", "linear", "srgb"
+    - ambientSource: one of "ambientSH", "envAtlas", "constant"
+    - ambientEncoding: one of null, "rgbm", "rgbe", "linear", "srgb"
     */
     onUpdateShader: callbacks.UpdateShader;
 }
@@ -16531,16 +16538,12 @@ export class ForwardRenderer {
  * @property exposure - The exposure value tweaks the overall brightness of
  * the scene. Defaults to 1.
  * @property skybox - The base cubemap texture used as the scene's skybox, if mip level is 0. Defaults to null.
- * @property skyboxPrefiltered128 - The prefiltered cubemap texture (size 128x128) used as the scene's skybox, if mip level 1. Defaults to null.
- * @property skyboxPrefiltered64 - The prefiltered cubemap texture (size 64x64) used as the scene's skybox, if mip level 2. Defaults to null.
- * @property skyboxPrefiltered32 - The prefiltered cubemap texture (size 32x32) used as the scene's skybox, if mip level 3. Defaults to null.
- * @property skyboxPrefiltered16 - The prefiltered cubemap texture (size 16x16) used as the scene's skybox, if mip level 4. Defaults to null.
- * @property skyboxPrefiltered8 - The prefiltered cubemap texture (size 8x8) used as the scene's skybox, if mip level 5. Defaults to null.
- * @property skyboxPrefiltered4 - The prefiltered cubemap texture (size 4x4) used as the scene's skybox, if mip level 6. Defaults to null.
  * @property skyboxIntensity - Multiplier for skybox intensity. Defaults to 1.
  * @property skyboxRotation - The rotation of the skybox to be displayed. Defaults to {@link Quat.IDENTITY}.
  * @property skyboxMip - The mip level of the skybox to be displayed. Only valid
  * for prefiltered cubemap skyboxes. Defaults to 0 (base level).
+ * @property prefilteredCubemaps - Set of 6 prefiltered cubemaps.
+ * @property envAtlas - The environment lighting atlas.
  * @property lightmapSizeMultiplier - The lightmap resolution multiplier.
  * Defaults to 1.
  * @property lightmapMaxResolution - The maximum lightmap resolution. Defaults to
@@ -16645,30 +16648,6 @@ export class Scene extends EventHandler {
      * The base cubemap texture used as the scene's skybox, if mip level is 0. Defaults to null.
     */
     skybox: Texture;
-    /**
-     * The prefiltered cubemap texture (size 128x128) used as the scene's skybox, if mip level 1. Defaults to null.
-    */
-    skyboxPrefiltered128: Texture;
-    /**
-     * The prefiltered cubemap texture (size 64x64) used as the scene's skybox, if mip level 2. Defaults to null.
-    */
-    skyboxPrefiltered64: Texture;
-    /**
-     * The prefiltered cubemap texture (size 32x32) used as the scene's skybox, if mip level 3. Defaults to null.
-    */
-    skyboxPrefiltered32: Texture;
-    /**
-     * The prefiltered cubemap texture (size 16x16) used as the scene's skybox, if mip level 4. Defaults to null.
-    */
-    skyboxPrefiltered16: Texture;
-    /**
-     * The prefiltered cubemap texture (size 8x8) used as the scene's skybox, if mip level 5. Defaults to null.
-    */
-    skyboxPrefiltered8: Texture;
-    /**
-     * The prefiltered cubemap texture (size 4x4) used as the scene's skybox, if mip level 6. Defaults to null.
-    */
-    skyboxPrefiltered4: Texture;
     /**
      * Multiplier for skybox intensity. Defaults to 1.
     */
@@ -16682,6 +16661,14 @@ export class Scene extends EventHandler {
     for prefiltered cubemap skyboxes. Defaults to 0 (base level).
     */
     skyboxMip: number;
+    /**
+     * Set of 6 prefiltered cubemaps.
+    */
+    prefilteredCubemaps: Texture[];
+    /**
+     * The environment lighting atlas.
+    */
+    envAtlas: Texture;
     /**
      * The lightmap resolution multiplier.
     Defaults to 1.