@zephyr3d/scene 0.9.0 → 0.9.2

package/dist/utility/serialization/scene/material.js

@@ -22,6 +22,7 @@ function getPBRCommonProps(manager) {
     return defineProps([
         {
             name: 'IOR',
+            description: 'Index of refraction for the material surface',
             type: 'float',
             default: 1.5,
             options: {
@@ -39,6 +40,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'OcclusionStrength',
+            description: 'Strength multiplier for the occlusion texture effect',
             type: 'float',
             phase: 2,
             default: 1,
@@ -60,6 +62,7 @@ function getPBRCommonProps(manager) {
         ...getTextureProps(manager, 'occlusionTexture', '2D', false, 0),
         {
             name: 'EmissiveColor',
+            description: 'Base self-illumination color emitted by the material',
             type: 'rgb',
             options: {
                 animatable: true
@@ -82,6 +85,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'EmissiveStrength',
+            description: 'Intensity multiplier for the emissive color and emissive texture',
             type: 'float',
             options: {
                 animatable: true,
@@ -102,6 +106,7 @@ function getPBRCommonProps(manager) {
         ...getTextureProps(manager, 'specularTexture', '2D', false, 0),
         {
             name: 'Transmission',
+            description: 'If true, enables light transmission through the material',
             type: 'bool',
             phase: 0,
             default: false,
@@ -117,6 +122,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'TransmissionFactor',
+            description: 'Amount of transmitted light, from fully opaque to fully transparent',
             type: 'float',
             phase: 1,
             default: 0,
@@ -140,6 +146,7 @@ function getPBRCommonProps(manager) {
         }),
         {
             name: 'ThicknessFactor',
+            description: 'Physical thickness used by transmission and volume attenuation',
             type: 'float',
             phase: 1,
             default: 0,
@@ -163,6 +170,7 @@ function getPBRCommonProps(manager) {
         }),
         {
             name: 'AttenuationColor',
+            description: 'Color tint applied to transmitted light as it travels through the material',
             type: 'rgb',
             phase: 1,
             default: [
@@ -187,6 +195,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'AttenuationDistance',
+            description: 'Distance over which transmitted light is attenuated inside the material',
             type: 'float',
             phase: 1,
             default: 99999,
@@ -207,6 +216,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'Iridescence',
+            description: 'If true, enables thin-film iridescence on the material surface',
             type: 'bool',
             phase: 0,
             default: false,
@@ -222,6 +232,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'IridescenceFactor',
+            description: 'Strength of the iridescence effect',
             type: 'float',
             phase: 1,
             default: 0,
@@ -245,6 +256,7 @@ function getPBRCommonProps(manager) {
         }),
         {
             name: 'IridescenceIOR',
+            description: 'Index of refraction used for the iridescence layer',
             type: 'float',
             phase: 1,
             default: 1.3,
@@ -263,6 +275,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'IridescenceThicknessMin',
+            description: 'Minimum thin-film thickness used for iridescence, typically in nanometers',
             type: 'float',
             phase: 1,
             default: 100,
@@ -283,6 +296,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'IridescenceThicknessMax',
+            description: 'Maximum thin-film thickness used for iridescence, typically in nanometers',
             type: 'float',
             phase: 1,
             default: 400,
@@ -306,6 +320,7 @@ function getPBRCommonProps(manager) {
         }),
         {
             name: 'ClearCoat',
+            description: 'If true, enables a clear coat layer on top of the material',
             type: 'bool',
             phase: 0,
             default: false,
@@ -321,6 +336,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'ClearCoatIntensity',
+            description: 'Strength of the clear coat layer',
             type: 'float',
             phase: 1,
             default: 0,
@@ -344,6 +360,7 @@ function getPBRCommonProps(manager) {
         }),
         {
             name: 'ClearCoatRoughnessFactor',
+            description: 'Roughness of the clear coat layer',
             type: 'float',
             phase: 1,
             default: 0,
@@ -370,6 +387,7 @@ function getPBRCommonProps(manager) {
         }),
         {
             name: 'Sheen',
+            description: 'If true, enables a soft fabric-like sheen layer',
             type: 'bool',
             phase: 0,
             default: false,
@@ -385,6 +403,7 @@ function getPBRCommonProps(manager) {
         },
         {
             name: 'SheenColorFactor',
+            description: 'Color of the sheen layer',
             type: 'rgb',
             phase: 1,
             default: [
@@ -412,6 +431,7 @@ function getPBRCommonProps(manager) {
         }),
         {
             name: 'SheenRoughnessFactor',
+            description: 'Roughness of the sheen layer',
             type: 'float',
             phase: 1,
             default: 0,
@@ -441,6 +461,7 @@ function getLitMaterialProps(manager) {
         ...getUnlitMaterialProps(manager),
         {
             name: 'doubleSidedLighting',
+            description: 'If true, lighting is evaluated on both sides of the surface',
             type: 'bool',
             default: false,
             isValid () {
@@ -455,6 +476,7 @@ function getLitMaterialProps(manager) {
         },
         {
             name: 'vertexNormal',
+            description: 'If true, uses vertex normals for lighting and normal mapping',
             type: 'bool',
             default: true,
             get (value) {
@@ -469,6 +491,7 @@ function getLitMaterialProps(manager) {
         },
         {
             name: 'vertexTangent',
+            description: 'If true, uses vertex tangents for tangent-space normal mapping',
             type: 'bool',
             default: false,
             get (value) {
@@ -488,6 +511,7 @@ function getUnlitMaterialProps(manager) {
     return defineProps([
         {
             name: 'vertexColor',
+            description: 'If true, multiplies the material color by per-vertex color data',
             type: 'bool',
             default: false,
             get (value) {
@@ -502,6 +526,7 @@ function getUnlitMaterialProps(manager) {
         },
         {
             name: 'AlbedoColor',
+            description: 'Base RGBA color of the material before lighting',
             type: 'rgba',
             options: {
                 animatable: true
@@ -537,6 +562,7 @@ function getUnlitMaterialProps(manager) {
                 return defineProps([
                     {
                         name: 'AlphaCutoff',
+                        description: 'If greater then 0, pixels which have alpha smaller than alpha cutoff will be discarded',
                         type: 'float',
                         default: 0,
                         options: {
@@ -556,6 +582,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'AlphaToCoverage',
+                        description: 'If true, alpha-to-coverage will be enabled',
                         type: 'bool',
                         default: false,
                         get (value) {
@@ -570,6 +597,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'AlphaDither',
+                        description: 'If true, alpha-dithering will be enabled',
                         type: 'bool',
                         default: false,
                         get (value) {
@@ -584,6 +612,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'BlendMode',
+                        description: 'Blending mode for this material',
                         type: 'string',
                         options: {
                             enum: {
@@ -612,6 +641,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'CullMode',
+                        description: 'Cull mode for this material',
                         type: 'string',
                         options: {
                             enum: {
@@ -640,6 +670,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'Opacity',
+                        description: 'Opacity value for this material, no effect if blendingMode is `none`',
                         type: 'float',
                         options: {
                             animatable: true,
@@ -659,6 +690,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'TAAStrength',
+                        description: 'TAA strength for this material',
                         type: 'float',
                         options: {
                             minValue: 0,
@@ -704,6 +736,7 @@ function getUnlitMaterialProps(manager) {
                 return defineProps([
                     {
                         name: 'SpriteTexture',
+                        description: 'Texture file path for the sprite',
                         type: 'object',
                         default: '',
                         options: {
@@ -763,6 +796,7 @@ function getUnlitMaterialProps(manager) {
                 return defineProps([
                     {
                         name: 'AlphaMap',
+                        description: 'Alpha texture file path',
                         type: 'object',
                         default: '',
                         options: {
@@ -804,6 +838,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'RampMap',
+                        description: 'Ramp texture file path',
                         type: 'object',
                         default: '',
                         options: {
@@ -857,6 +892,7 @@ function getUnlitMaterialProps(manager) {
                 return defineProps([
                     {
                         name: 'doubleSidedLighting',
+                        description: 'If true, double-sided lighting will be enabled',
                         type: 'bool',
                         default: false,
                         isValid () {
@@ -871,6 +907,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'Reflection',
+                        description: 'Reflection mode for the material',
                         type: 'string',
                         default: 'ggx',
                         options: {
@@ -901,6 +938,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfaceScattering',
+                        description: 'If true, subsurface-scattering will be enabled',
                         type: 'bool',
                         phase: 0,
                         default: false,
@@ -916,6 +954,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfaceColor',
+                        description: 'Subsurface-scattering color',
                         type: 'rgb',
                         phase: 1,
                         default: [
@@ -947,6 +986,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfaceScale',
+                        description: 'Scale value for subsurface-scattering',
                         type: 'float',
                         phase: 1,
                         default: 0.5,
@@ -970,6 +1010,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfacePower',
+                        description: 'Power value for subsurface-scattering',
                         type: 'float',
                         phase: 1,
                         default: 1.5,
@@ -993,6 +1034,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfaceIntensity',
+                        description: 'Intensity value for subsurface-scattering',
                         type: 'float',
                         phase: 1,
                         default: 0.5,
@@ -1016,6 +1058,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'Anisotropy',
+                        description: 'Anistropy value',
                         type: 'float',
                         default: 0.75,
                         options: {
@@ -1038,6 +1081,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'AnisotropyDirection',
+                        description: 'Anisotropy direction',
                         type: 'float',
                         default: 0,
                         options: {
@@ -1060,6 +1104,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'AnisotropyDirectionScaleBias',
+                        description: 'Anisotropy direction scale bias',
                         type: 'vec2',
                         default: [
                             1,
@@ -1140,6 +1185,7 @@ function getUnlitMaterialProps(manager) {
                 return defineProps([
                     {
                         name: 'Shininess',
+                        description: 'Shininess value',
                         type: 'float',
                         options: {
                             animatable: true,
@@ -1158,6 +1204,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'ScatterWrap',
+                        description: 'Scatter wrap for light warping',
                         type: 'float',
                         options: {
                             animatable: true,
@@ -1176,6 +1223,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'ScatterWidth',
+                        description: 'Scatter width for light wrapping',
                         type: 'float',
                         options: {
                             animatable: true,
@@ -1194,6 +1242,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'ScatterColor',
+                        description: 'Scatter color for light warping',
                         type: 'rgb',
                         options: {
                             animatable: true
@@ -1235,6 +1284,7 @@ function getUnlitMaterialProps(manager) {
                 return defineProps([
                     {
                         name: 'Metallic',
+                        description: 'Metallic value',
                         type: 'float',
                         options: {
                             animatable: true,
@@ -1253,6 +1303,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'Roughness',
+                        description: 'Roughness value',
                         type: 'float',
                         options: {
                             animatable: true,
@@ -1271,6 +1322,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SpecularFactor',
+                        description: 'RGBA specular factor used to tint and scale specular reflections',
                         type: 'rgba',
                         options: {
                             animatable: true
@@ -1295,6 +1347,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'Reflection',
+                        description: 'Reflection mode',
                         type: 'string',
                         default: 'ggx',
                         options: {
@@ -1325,6 +1378,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'Anisotropy',
+                        description: 'Strength of anisotropic reflections; values near 0 behave isotropically',
                         type: 'float',
                         default: 0.75,
                         options: {
@@ -1347,6 +1401,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'AnisotropyDirection',
+                        description: 'Rotation angle in degrees for the anisotropic highlight direction',
                         type: 'float',
                         default: 0,
                         options: {
@@ -1372,6 +1427,7 @@ function getUnlitMaterialProps(manager) {
                     }),
                     {
                         name: 'AnisotropyDirectionScaleBias',
+                        description: 'Scale and bias applied when decoding anisotropy direction from its texture',
                         type: 'vec2',
                         default: [
                             1,
@@ -1399,6 +1455,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfaceScattering',
+                        description: 'If true, enables subsurface scattering for translucent materials',
                         type: 'bool',
                         phase: 0,
                         default: false,
@@ -1414,6 +1471,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfaceColor',
+                        description: 'Color tint of the subsurface scattering effect',
                         type: 'rgb',
                         phase: 1,
                         default: [
@@ -1445,6 +1503,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfaceScale',
+                        description: 'Distance scale of the subsurface scattering effect',
                         type: 'float',
                         phase: 1,
                         default: 0.5,
@@ -1468,6 +1527,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfacePower',
+                        description: 'Falloff power controlling how quickly subsurface scattering fades',
                         type: 'float',
                         phase: 1,
                         default: 1.5,
@@ -1491,6 +1551,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'SubsurfaceIntensity',
+                        description: 'Overall intensity of the subsurface scattering effect',
                         type: 'float',
                         phase: 1,
                         default: 0.5,
@@ -1534,6 +1595,7 @@ function getUnlitMaterialProps(manager) {
                 return defineProps([
                     {
                         name: 'SpecularFactor',
+                        description: 'RGB specular color multiplier for reflected highlights',
                         type: 'rgb',
                         options: {
                             animatable: true
@@ -1556,6 +1618,7 @@ function getUnlitMaterialProps(manager) {
                     },
                     {
                         name: 'GlossnessFactor',
+                        description: 'Glossiness of the surface; higher values produce sharper reflections',
                         type: 'float',
                         options: {
                             animatable: true,