@zephyr3d/scene 0.9.1 → 0.9.2

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

@@ -54,6 +54,7 @@ import '../../../scene/raycast_visitor.js';
             return defineProps([
                 {
                     name: 'UseScreenSettings',
+                    description: 'Whether this camera is adapted to screen settings',
                     type: 'bool',
                     default: false,
                     get (value) {
@@ -65,6 +66,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'DesignWidth',
+                    description: 'Design width of screen settings',
                     type: 'int',
                     options: {
                         minValue: 1
@@ -85,6 +87,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'DesignHeight',
+                    description: 'Design height of screen settings',
                     type: 'int',
                     options: {
                         minValue: 1
@@ -105,6 +108,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'ScreenScaleMode',
+                    description: 'Scale mode of screen settings, valid values are `fit` | `cover` | `stretch` | `fit-width` | `fit-height`',
                     type: 'string',
                     default: 'cover',
                     options: {
@@ -140,6 +144,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'HDR',
+                    description: 'If true, float point framebuffer will be used for rendering',
                     type: 'bool',
                     default: false,
                     get (value) {
@@ -151,6 +156,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'HiZ',
+                    description: 'If true, HiZ rendering pass will be enabled',
                     type: 'bool',
                     default: false,
                     get (value) {
@@ -162,6 +168,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'OITMode',
+                    description: 'Which OIT mode should be used for transparent rendering, valid values are `none` | `weighted` | `abuffer`',
                     type: 'string',
                     default: 'none',
                     options: {
@@ -189,6 +196,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'ABufferLayers',
+                    description: 'Maximum layers for abuffer OIT',
                     type: 'int',
                     default: 20,
                     options: {
@@ -208,6 +216,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'ToneMapEnabled',
+                    description: 'If true, tonemap post-processing will be enabled',
                     type: 'bool',
                     phase: 0,
                     default: true,
@@ -224,6 +233,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'ToneMapExposure',
+                    description: 'Exposure value for tonemapping',
                     type: 'float',
                     options: {
                         minValue: 0,
@@ -242,6 +252,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'ColorAdjustEnabled',
+                    description: `If true, color adjust post-processing will be enabled`,
                     type: 'bool',
                     phase: 0,
                     default: false,
@@ -258,6 +269,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'ColorAdjustSaturation',
+                    description: 'Saturation value for color adjust post-processing',
                     type: 'float',
                     phase: 1,
                     default: 1,
@@ -280,6 +292,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'ColorAdjustContrast',
+                    description: 'Contrast value for color adjust post-processing',
                     type: 'float',
                     phase: 1,
                     default: 1,
@@ -302,6 +315,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'ColorAdjustHue',
+                    description: 'Hue value for color adjust post-processing',
                     type: 'float',
                     phase: 1,
                     default: 0,
@@ -324,6 +338,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'Sharpen',
+                    description: 'Sharpen value for color adjust post-processing',
                     type: 'float',
                     phase: 1,
                     default: 0,
@@ -346,6 +361,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'BloomEnabled',
+                    description: 'If true, bloom post-processing will be enabled',
                     type: 'bool',
                     phase: 0,
                     default: true,
@@ -362,6 +378,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'BloomMaxDownsampleLevels',
+                    description: 'Maximum downsample levels for bloom post-processing',
                     type: 'int',
                     options: {
                         minValue: 0,
@@ -380,6 +397,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'BloomDownsampleLimit',
+                    description: 'Minimum downsample framebuffer resolution for bloom post-processing',
                     type: 'int',
                     options: {
                         minValue: 2,
@@ -398,6 +416,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'BloomThreshold',
+                    description: 'Color threshold for bloom post-processing',
                     type: 'float',
                     options: {
                         animatable: true,
@@ -417,6 +436,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'BloomThresholdKnee',
+                    description: 'Color threshold-knee value for bloom post-processing',
                     type: 'float',
                     options: {
                         animatable: true,
@@ -436,6 +456,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'BloomIntensity',
+                    description: 'Intensity value for bloom post-processing',
                     type: 'float',
                     options: {
                         animatable: true,
@@ -455,6 +476,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'FXAAEnabled',
+                    description: 'If true, FXAA post-processing will be enabled',
                     type: 'bool',
                     phase: 0,
                     default: true,
@@ -471,6 +493,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'TAAEnabled',
+                    description: 'If true, TAA post-processing will be enabled',
                     type: 'bool',
                     phase: 0,
                     default: false,
@@ -487,6 +510,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'TAADebug',
+                    description: 'Debug channel for TAA post-processing',
                     type: 'int',
                     phase: 1,
                     options: {
@@ -528,6 +552,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'MotionBlurEnabled',
+                    description: 'If true, motion blur post-processing will be enabled',
                     type: 'bool',
                     phase: 0,
                     default: false,
@@ -544,6 +569,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'MotionBlurStrength',
+                    description: 'Strength value for motion blur post-processing',
                     type: 'float',
                     phase: 1,
                     default: 1,
@@ -566,6 +592,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSREnabled',
+                    description: 'If true, SSR post-processing will be enabled',
                     type: 'bool',
                     phase: 0,
                     default: false,
@@ -582,6 +609,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRMaxRoughness',
+                    description: 'Maximum roughness value for SSR post-processing',
                     type: 'float',
                     phase: 1,
                     default: 0.8,
@@ -603,6 +631,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRRoughnessFactor',
+                    description: 'Global roughness multiplier for debugging',
                     type: 'float',
                     phase: 1,
                     default: 1.0,
@@ -624,6 +653,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRStride',
+                    description: 'How many pixels per step for screen-space ray tracing, no effect if HiZ is enabled',
                     type: 'int',
                     phase: 1,
                     default: 2,
@@ -645,6 +675,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRMaxDistance',
+                    description: 'Maximum distance in pixels for screen-space ray tracing',
                     type: 'float',
                     phase: 1,
                     default: 100,
@@ -666,6 +697,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRMaxSteps',
+                    description: 'Maximum steps for screen-space ray tracing',
                     type: 'int',
                     phase: 1,
                     default: 120,
@@ -687,6 +719,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRThickness',
+                    description: 'Thickness value for screen-space ray tracing',
                     type: 'float',
                     phase: 1,
                     default: 0.5,
@@ -708,6 +741,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRBlurScale',
+                    description: 'Scale value of bilateral blur for SSR post-processing',
                     phase: 1,
                     type: 'float',
                     default: 0.01,
@@ -729,6 +763,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRBlurDepthCutoff',
+                    description: 'Depth cutoff of bilateral blur for SSR post-processing',
                     phase: 1,
                     type: 'float',
                     default: 2,
@@ -750,6 +785,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRBlurKernelSize',
+                    description: 'Kernel size of bilateral blur for SSR post-processing',
                     type: 'int',
                     phase: 1,
                     default: 10,
@@ -771,6 +807,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRBlurStdDev',
+                    description: 'Stddev of bilateral blur for SSR post-processing',
                     type: 'float',
                     phase: 1,
                     default: 10,
@@ -792,6 +829,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSRCalcThickness',
+                    description: 'If true, automatically calculate thickness for screen-space ray tracing',
                     type: 'bool',
                     phase: 1,
                     default: false,
@@ -811,6 +849,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSAOEnabled',
+                    description: 'If true, SAO post-processing will be enabled',
                     type: 'bool',
                     phase: 0,
                     default: false,
@@ -827,6 +866,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSAOScale',
+                    description: 'Scale value for SAO post-processing',
                     type: 'float',
                     phase: 0,
                     default: 10,
@@ -843,6 +883,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSAOBias',
+                    description: 'Bias value for SAO post-processing',
                     type: 'float',
                     phase: 0,
                     default: 1,
@@ -859,6 +900,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSAORadius',
+                    description: 'Radius value for SAO post-processing',
                     type: 'float',
                     phase: 0,
                     default: 100,
@@ -875,6 +917,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'SSAOIntensity',
+                    description: 'Intensity value for SAO post-processing',
                     type: 'float',
                     phase: 0,
                     default: 2.5,
@@ -909,6 +952,7 @@ import '../../../scene/raycast_visitor.js';
             return defineProps([
                 {
                     name: 'FovVertical',
+                    description: 'Vertical FOV in radians',
                     type: 'float',
                     default: Math.PI / 3,
                     options: {
@@ -924,6 +968,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'Near',
+                    description: 'Near clip plane',
                     type: 'float',
                     default: 1,
                     get (value) {
@@ -935,6 +980,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'Far',
+                    description: 'Far clip plane',
                     type: 'float',
                     default: 1000,
                     get (value) {
@@ -946,6 +992,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'AutoAspect',
+                    description: 'If true, automatically determine aspect ratio',
                     type: 'bool',
                     default: true,
                     get (value) {
@@ -975,6 +1022,7 @@ import '../../../scene/raycast_visitor.js';
             return defineProps([
                 {
                     name: 'Left',
+                    description: 'Left clip plane',
                     type: 'float',
                     default: -1,
                     get (value) {
@@ -986,6 +1034,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'Right',
+                    description: 'Right clip plane',
                     type: 'float',
                     default: 1,
                     get (value) {
@@ -997,6 +1046,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'Bottom',
+                    description: 'Bottom clip plane',
                     type: 'float',
                     default: -1,
                     get (value) {
@@ -1008,6 +1058,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'Top',
+                    description: 'Top clip plane',
                     type: 'float',
                     default: 1,
                     get (value) {
@@ -1019,6 +1070,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'Near',
+                    description: 'Near clip plane',
                     type: 'float',
                     default: -1,
                     get (value) {
@@ -1030,6 +1082,7 @@ import '../../../scene/raycast_visitor.js';
                 },
                 {
                     name: 'Far',
+                    description: 'Far clip plane',
                     type: 'float',
                     default: 1,
                     get (value) {