Renamed shadow type constants, old constants are deprecated (#7145)

Co-authored-by: Martin Valigursky <[email protected]>
playcanvas · Nov 27, 2024 · 30a788d · 30a788d
1 parent d68f412
commit 30a788d
Show file tree

Hide file tree

Showing 30 changed files with 153 additions and 139 deletions.
diff --git a/examples/src/examples/animation/blend-trees-1d.example.mjs b/examples/src/examples/animation/blend-trees-1d.example.mjs
@@ -92,7 +92,7 @@ assetListLoader.load(() => {
         castShadows: true,
         intensity: 1.5,
         normalOffsetBias: 0.02,
-        shadowType: pc.SHADOW_PCF5,
+        shadowType: pc.SHADOW_PCF5_32F,
         shadowDistance: 6,
         shadowResolution: 2048,
         shadowBias: 0.02

diff --git a/examples/src/examples/animation/blend-trees-2d-cartesian.example.mjs b/examples/src/examples/animation/blend-trees-2d-cartesian.example.mjs
@@ -97,7 +97,7 @@ assetListLoader.load(() => {
         castShadows: true,
         intensity: 1.5,
         normalOffsetBias: 0.02,
-        shadowType: pc.SHADOW_PCF5,
+        shadowType: pc.SHADOW_PCF5_32F,
         shadowDistance: 6,
         shadowResolution: 2048,
         shadowBias: 0.02

diff --git a/examples/src/examples/animation/blend-trees-2d-directional.example.mjs b/examples/src/examples/animation/blend-trees-2d-directional.example.mjs
@@ -95,7 +95,7 @@ assetListLoader.load(() => {
         castShadows: true,
         intensity: 1.5,
         normalOffsetBias: 0.02,
-        shadowType: pc.SHADOW_PCF5,
+        shadowType: pc.SHADOW_PCF5_32F,
         shadowDistance: 6,
         shadowResolution: 2048,
         shadowBias: 0.02

diff --git a/examples/src/examples/animation/layer-masks.example.mjs b/examples/src/examples/animation/layer-masks.example.mjs
@@ -113,7 +113,7 @@ assetListLoader.load(() => {
         castShadows: true,
         intensity: 1.5,
         normalOffsetBias: 0.02,
-        shadowType: pc.SHADOW_PCF5,
+        shadowType: pc.SHADOW_PCF5_32F,
         shadowDistance: 6,
         shadowResolution: 2048,
         shadowBias: 0.02

diff --git a/examples/src/examples/graphics/clustered-omni-shadows.controls.mjs b/examples/src/examples/graphics/clustered-omni-shadows.controls.mjs
@@ -17,12 +17,12 @@ export const controls = ({ observer, ReactPCUI, React, jsx, fragment }) => {
                 link: { observer, path: 'settings.shadowType' },
                 type: 'number',
                 options: [
-                    { v: pc.SHADOW_PCF1, t: 'PCF1' },
-                    { v: pc.SHADOW_PCF3, t: 'PCF3' },
-                    { v: pc.SHADOW_PCF5, t: 'PCF5' },
-                    { v: pc.SHADOW_PCF1_FLOAT16, t: 'PCF1_FLOAT16' },
-                    { v: pc.SHADOW_PCF3_FLOAT16, t: 'PCF3_FLOAT16' },
-                    { v: pc.SHADOW_PCF5_FLOAT16, t: 'PCF5_FLOAT16' }
+                    { v: pc.SHADOW_PCF1_32F, t: 'PCF1_32F' },
+                    { v: pc.SHADOW_PCF3_32F, t: 'PCF3_32F' },
+                    { v: pc.SHADOW_PCF5_32F, t: 'PCF5_32F' },
+                    { v: pc.SHADOW_PCF1_16F, t: 'PCF1_16F' },
+                    { v: pc.SHADOW_PCF3_16F, t: 'PCF3_16F' },
+                    { v: pc.SHADOW_PCF5_16F, t: 'PCF5_16F' }
                 ]
             })
         ),

diff --git a/examples/src/examples/graphics/clustered-omni-shadows.example.mjs b/examples/src/examples/graphics/clustered-omni-shadows.example.mjs
@@ -70,7 +70,7 @@ assetListLoader.load(() => {
 
     data.set('settings', {
         shadowAtlasResolution: 1300, // shadow map resolution storing all shadows
-        shadowType: pc.SHADOW_PCF3, // shadow filter type
+        shadowType: pc.SHADOW_PCF3_32F, // shadow filter type
         shadowsEnabled: true,
         cookiesEnabled: true
     });

diff --git a/examples/src/examples/graphics/clustered-spot-shadows.controls.mjs b/examples/src/examples/graphics/clustered-spot-shadows.controls.mjs
@@ -44,12 +44,12 @@ export const controls = ({ observer, ReactPCUI, React, jsx, fragment }) => {
                     link: { observer, path: 'settings.shadowType' },
                     type: 'number',
                     options: [
-                        { v: pc.SHADOW_PCF1, t: 'PCF1' },
-                        { v: pc.SHADOW_PCF3, t: 'PCF3' },
-                        { v: pc.SHADOW_PCF5, t: 'PCF5' },
-                        { v: pc.SHADOW_PCF1_FLOAT16, t: 'PCF1_FLOAT16' },
-                        { v: pc.SHADOW_PCF3_FLOAT16, t: 'PCF3_FLOAT16' },
-                        { v: pc.SHADOW_PCF5_FLOAT16, t: 'PCF5_FLOAT16' }
+                        { v: pc.SHADOW_PCF1_32F, t: 'PCF1_32F' },
+                        { v: pc.SHADOW_PCF3_32F, t: 'PCF3_32F' },
+                        { v: pc.SHADOW_PCF5_32F, t: 'PCF5_32F' },
+                        { v: pc.SHADOW_PCF1_16F, t: 'PCF1_16F' },
+                        { v: pc.SHADOW_PCF3_16F, t: 'PCF3_16F' },
+                        { v: pc.SHADOW_PCF5_16F, t: 'PCF5_16F' }
                     ]
                 })
             )

diff --git a/examples/src/examples/graphics/clustered-spot-shadows.example.mjs b/examples/src/examples/graphics/clustered-spot-shadows.example.mjs
@@ -61,7 +61,7 @@ assetListLoader.load(() => {
 
     data.set('settings', {
         shadowAtlasResolution: 1024, // shadow map resolution storing all shadows
-        shadowType: pc.SHADOW_PCF3, // shadow filter type
+        shadowType: pc.SHADOW_PCF3_32F, // shadow filter type
         shadowsEnabled: true,
         cookiesEnabled: true,
         shadowIntensity: 1,

diff --git a/examples/src/examples/graphics/contact-hardening-shadows.controls.mjs b/examples/src/examples/graphics/contact-hardening-shadows.controls.mjs
@@ -46,8 +46,8 @@ export const controls = ({ observer, ReactPCUI, React, jsx, fragment }) => {
                     binding: new BindingTwoWay(),
                     link: { observer, path: 'script.area.shadowType' },
                     options: [
-                        { v: pc.SHADOW_PCSS, t: 'PCSS' },
-                        { v: pc.SHADOW_PCF5, t: 'PCF' }
+                        { v: pc.SHADOW_PCSS_32F, t: 'PCSS_32F' },
+                        { v: pc.SHADOW_PCF5_32F, t: 'PCF_32F' }
                     ]
                 })
             )
@@ -91,8 +91,8 @@ export const controls = ({ observer, ReactPCUI, React, jsx, fragment }) => {
                     binding: new BindingTwoWay(),
                     link: { observer, path: 'script.point.shadowType' },
                     options: [
-                        { v: pc.SHADOW_PCSS, t: 'PCSS' },
-                        { v: pc.SHADOW_PCF5, t: 'PCF' }
+                        { v: pc.SHADOW_PCSS_32F, t: 'PCSS_32F' },
+                        { v: pc.SHADOW_PCF5_32F, t: 'PCF_32F' }
                     ]
                 })
             )
@@ -136,8 +136,8 @@ export const controls = ({ observer, ReactPCUI, React, jsx, fragment }) => {
                     binding: new BindingTwoWay(),
                     link: { observer, path: 'script.directional.shadowType' },
                     options: [
-                        { v: pc.SHADOW_PCSS, t: 'PCSS' },
-                        { v: pc.SHADOW_PCF5, t: 'PCF' }
+                        { v: pc.SHADOW_PCSS_32F, t: 'PCSS_32F' },
+                        { v: pc.SHADOW_PCF5_32F, t: 'PCF_32F' }
                     ]
                 })
             )

diff --git a/examples/src/examples/graphics/contact-hardening-shadows.example.mjs b/examples/src/examples/graphics/contact-hardening-shadows.example.mjs
@@ -113,19 +113,19 @@ assetListLoader.load(() => {
             enabled: true,
             intensity: 16.0,
             size: 2,
-            shadowType: pc.SHADOW_PCSS
+            shadowType: pc.SHADOW_PCSS_32F
         },
         point: {
             enabled: true,
             intensity: 4.0,
             size: 2,
-            shadowType: pc.SHADOW_PCSS
+            shadowType: pc.SHADOW_PCSS_32F
         },
         directional: {
             enabled: true,
             intensity: 2.0,
             size: 1,
-            shadowType: pc.SHADOW_PCSS
+            shadowType: pc.SHADOW_PCSS_32F
         }
     });
 

diff --git a/examples/src/examples/graphics/dithered-transparency.example.mjs b/examples/src/examples/graphics/dithered-transparency.example.mjs
@@ -126,7 +126,7 @@ assetListLoader.load(() => {
         range: 200,
         castShadows: true,
         shadowResolution: 2048,
-        shadowType: pc.SHADOW_VSM16,
+        shadowType: pc.SHADOW_VSM_16F,
         vsmBlurSize: 20,
         shadowBias: 0.1,
         normalOffsetBias: 0.1

diff --git a/examples/src/examples/graphics/ground-fog.example.mjs b/examples/src/examples/graphics/ground-fog.example.mjs
@@ -119,7 +119,7 @@ assetListLoader.load(() => {
         castShadows: true,
         shadowDistance: 1000,
         shadowResolution: 2048,
-        shadowType: pc.SHADOW_PCF3
+        shadowType: pc.SHADOW_PCF3_32F
     });
     app.root.addChild(dirLight);
     dirLight.setLocalEulerAngles(45, 350, 20);

diff --git a/examples/src/examples/graphics/lights-baked-a-o.example.mjs b/examples/src/examples/graphics/lights-baked-a-o.example.mjs
@@ -96,7 +96,7 @@ assetListLoader.load(() => {
         shadowBias: 0.2,
         shadowDistance: 100,
         shadowResolution: 2048,
-        shadowType: pc.SHADOW_PCF3,
+        shadowType: pc.SHADOW_PCF3_32F,
         color: new pc.Color(0.7, 0.7, 0.5),
         intensity: 1.6
     });
@@ -115,7 +115,7 @@ assetListLoader.load(() => {
         shadowBias: 0.2,
         shadowDistance: 25,
         shadowResolution: 512,
-        shadowType: pc.SHADOW_PCF3,
+        shadowType: pc.SHADOW_PCF3_32F,
         color: pc.Color.YELLOW,
         range: 25,
         intensity: 0.9
@@ -135,7 +135,7 @@ assetListLoader.load(() => {
         shadowBias: 0.2,
         shadowDistance: 50,
         shadowResolution: 512,
-        shadowType: pc.SHADOW_PCF3,
+        shadowType: pc.SHADOW_PCF3_32F,
         color: pc.Color.RED,
         range: 10,
         intensity: 2.5

diff --git a/examples/src/examples/graphics/lights-baked.example.mjs b/examples/src/examples/graphics/lights-baked.example.mjs
@@ -87,7 +87,7 @@ light.addComponent('light', {
     shadowBias: 0.2,
     shadowDistance: 50,
     shadowResolution: 2048,
-    shadowType: pc.SHADOW_PCF3,
+    shadowType: pc.SHADOW_PCF3_32F,
     color: pc.Color.GREEN,
     type: 'directional'
 });
@@ -105,7 +105,7 @@ lightPoint.addComponent('light', {
     shadowBias: 0.2,
     shadowDistance: 50,
     shadowResolution: 512,
-    shadowType: pc.SHADOW_PCF3,
+    shadowType: pc.SHADOW_PCF3_32F,
     color: pc.Color.RED,
     range: 100,
     type: 'point'

diff --git a/examples/src/examples/graphics/lights.example.mjs b/examples/src/examples/graphics/lights.example.mjs
@@ -184,7 +184,7 @@ assetListLoader.load(() => {
             castShadows: true,
             shadowBias: 0.05,
             normalOffsetBias: 0.03,
-            shadowType: pc.SHADOW_PCF3,
+            shadowType: pc.SHADOW_PCF3_32F,
             shadowResolution: 256,
             range: 111,
             cookieAsset: cubemapAsset,

diff --git a/examples/src/examples/graphics/shadow-cascades.controls.mjs b/examples/src/examples/graphics/shadow-cascades.controls.mjs
@@ -18,15 +18,15 @@ export const controls = ({ observer, ReactPCUI, React, jsx, fragment }) => {
                     link: { observer, path: 'settings.light.shadowType' },
                     type: 'number',
                     options: [
-                        { v: pc.SHADOW_PCF1, t: 'PCF1' },
-                        { v: pc.SHADOW_PCF3, t: 'PCF3' },
-                        { v: pc.SHADOW_PCF5, t: 'PCF5' },
-                        { v: pc.SHADOW_PCF1_FLOAT16, t: 'PCF1_FLOAT16' },
-                        { v: pc.SHADOW_PCF3_FLOAT16, t: 'PCF3_FLOAT16' },
-                        { v: pc.SHADOW_PCF5_FLOAT16, t: 'PCF5_FLOAT16' },
+                        { v: pc.SHADOW_PCF1_32F, t: 'PCF1_32F' },
+                        { v: pc.SHADOW_PCF3_32F, t: 'PCF3_32F' },
+                        { v: pc.SHADOW_PCF5_32F, t: 'PCF5_32F' },
+                        { v: pc.SHADOW_PCF1_16F, t: 'PCF1_16F' },
+                        { v: pc.SHADOW_PCF3_16F, t: 'PCF3_16F' },
+                        { v: pc.SHADOW_PCF5_16F, t: 'PCF5_16F' },
                         { v: pc.SHADOW_VSM8, t: 'VSM8' },
-                        { v: pc.SHADOW_VSM16, t: 'VSM16' },
-                        { v: pc.SHADOW_VSM32, t: 'VSM32' }
+                        { v: pc.SHADOW_VSM_16F, t: 'VSM_16F' },
+                        { v: pc.SHADOW_VSM_32F, t: 'VSM_32F' }
                     ]
                 })
             ),

diff --git a/examples/src/examples/graphics/shadow-cascades.example.mjs b/examples/src/examples/graphics/shadow-cascades.example.mjs
@@ -54,7 +54,7 @@ assetListLoader.load(() => {
             numCascades: 4, // number of cascades
             shadowResolution: 2048, // shadow map resolution storing 4 cascades
             cascadeDistribution: 0.5, // distribution of cascade distances to prefer sharpness closer to the camera
-            shadowType: pc.SHADOW_PCF3, // shadow filter type
+            shadowType: pc.SHADOW_PCF3_32F, // shadow filter type
             vsmBlurSize: 11, // shader filter blur size for VSM shadows
             everyFrame: true // true if all cascades update every frame
         }

diff --git a/examples/src/examples/physics/offset-collision.example.mjs b/examples/src/examples/physics/offset-collision.example.mjs
@@ -83,7 +83,7 @@ assetListLoader.load(() => {
         castShadows: true,
         intensity: 1.5,
         normalOffsetBias: 0.2,
-        shadowType: pc.SHADOW_PCF5,
+        shadowType: pc.SHADOW_PCF5_32F,
         shadowDistance: 12,
         shadowResolution: 4096,
         shadowBias: 0.2

diff --git a/src/framework/app-base.js b/src/framework/app-base.js
@@ -1416,9 +1416,12 @@ class AppBase extends EventHandler {
      * @param {number} settings.render.lightingMaxLightsPerCell - Maximum number of lights a cell can store.
      * @param {number} settings.render.lightingShadowType - The type of shadow filtering used by all shadows. Can be:
      *
-     * - {@link SHADOW_PCF1}: PCF 1x1 sampling.
-     * - {@link SHADOW_PCF3}: PCF 3x3 sampling.
-     * - {@link SHADOW_PCF5}: PCF 5x5 sampling.
+     * - {@link SHADOW_PCF1_32F}
+     * - {@link SHADOW_PCF3_32F}
+     * - {@link SHADOW_PCF5_32F}
+     * - {@link SHADOW_PCF1_16F}
+     * - {@link SHADOW_PCF3_16F}
+     * - {@link SHADOW_PCF5_16F}
      *
      * @param {Vec3} settings.render.lightingCells - Number of cells along each world space axis the space containing lights
      * is subdivided into.

diff --git a/src/framework/components/light/component.js b/src/framework/components/light/component.js
@@ -547,16 +547,16 @@ class LightComponent extends Component {
     /**
      * Sets the type of shadows being rendered by this light. Can be:
      *
-     * - {@link SHADOW_PCF1}
-     * - {@link SHADOW_PCF3}
-     * - {@link SHADOW_PCF5}
-     * - {@link SHADOW_PCF1_FLOAT16}
-     * - {@link SHADOW_PCF3_FLOAT16}
-     * - {@link SHADOW_PCF5_FLOAT16}
+     * - {@link SHADOW_PCF1_32F}
+     * - {@link SHADOW_PCF3_32F}
+     * - {@link SHADOW_PCF5_32F}
+     * - {@link SHADOW_PCF1_16F}
+     * - {@link SHADOW_PCF3_16F}
+     * - {@link SHADOW_PCF5_16F}
      * - {@link SHADOW_VSM8}
-     * - {@link SHADOW_VSM16}
-     * - {@link SHADOW_VSM32}
-     * - {@link SHADOW_PCSS}
+     * - {@link SHADOW_VSM_16F}
+     * - {@link SHADOW_VSM_32F}
+     * - {@link SHADOW_PCSS_32F}
      *
      * @type {number}
      */

diff --git a/src/framework/components/light/data.js b/src/framework/components/light/data.js
@@ -4,7 +4,7 @@ import {
     LAYERID_WORLD,
     LIGHTSHAPE_PUNCTUAL,
     LIGHTFALLOFF_LINEAR,
-    SHADOW_PCF3,
+    SHADOW_PCF3_32F,
     SHADOWUPDATE_REALTIME
 } from '../../../scene/constants.js';
 
@@ -58,7 +58,7 @@ class LightComponentData {
 
     falloffMode = LIGHTFALLOFF_LINEAR;
 
-    shadowType = SHADOW_PCF3;
+    shadowType = SHADOW_PCF3_32F;
 
     vsmBlurSize = 11;
 

diff --git a/src/framework/lightmapper/bake-light-ambient.js b/src/framework/lightmapper/bake-light-ambient.js
@@ -2,7 +2,7 @@ import { Vec3 } from '../../core/math/vec3.js';
 import { random } from '../../core/math/random.js';
 import { Color } from '../../core/math/color.js';
 import { Entity } from '../entity.js';
-import { SHADOW_PCF3 } from '../../scene/constants.js';
+import { SHADOW_PCF3_32F } from '../../scene/constants.js';
 import { BakeLight } from './bake-light.js';
 
 const _tempPoint = new Vec3();
@@ -24,7 +24,7 @@ class BakeLightAmbient extends BakeLight {
             shadowBias: 0.2,
             shadowDistance: 1,  // this is updated during shadow map rendering
             shadowResolution: 2048,
-            shadowType: SHADOW_PCF3,
+            shadowType: SHADOW_PCF3_32F,
             color: Color.WHITE,
             intensity: 1,
             bakeDir: false