feat: modules moved and engine moved to submodule
This commit is contained in:
Jan van der Weide
parent
dfb5e645cd
commit
c33d2130cc
5136 changed files with 225275 additions and 64485 deletions
|
|
@ -1259,6 +1259,7 @@
|
|||
<param index="0" name="enable" type="bool" />
|
||||
<description>
|
||||
If [param enable] is [code]true[/code], enables bicubic upscaling for glow which improves quality at the cost of performance. Equivalent to [member ProjectSettings.rendering/environment/glow/upscale_mode].
|
||||
[b]Note:[/b] This setting is only effective when using the Forward+ or Mobile rendering methods, as Compatibility uses a different glow implementation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="environment_set_adjustment">
|
||||
|
|
@ -1344,6 +1345,16 @@
|
|||
Configures fog for the specified environment RID. See [code]fog_*[/code] properties in [Environment] for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="environment_set_fog_depth">
|
||||
<return type="void" />
|
||||
<param index="0" name="env" type="RID" />
|
||||
<param index="1" name="curve" type="float" />
|
||||
<param index="2" name="begin" type="float" />
|
||||
<param index="3" name="end" type="float" />
|
||||
<description>
|
||||
Configures fog depth for the specified environment RID. Only has an effect when the fog mode of the environment is [constant ENV_FOG_MODE_DEPTH]. See [code]fog_depth_*[/code] properties in [Environment] for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="environment_set_glow">
|
||||
<return type="void" />
|
||||
<param index="0" name="env" type="RID" />
|
||||
|
|
@ -4668,7 +4679,7 @@
|
|||
Flag used to mark that the array contains 2D vertices.
|
||||
</constant>
|
||||
<constant name="ARRAY_FLAG_USE_DYNAMIC_UPDATE" value="67108864" enum="ArrayFormat" is_bitfield="true">
|
||||
Flag indices that the mesh data will use [code]GL_DYNAMIC_DRAW[/code] on GLES. Unused on Vulkan.
|
||||
Flag used to mark that the mesh data will use [code]GL_DYNAMIC_DRAW[/code] on GLES. Unused on Vulkan.
|
||||
</constant>
|
||||
<constant name="ARRAY_FLAG_USE_8_BONE_WEIGHTS" value="134217728" enum="ArrayFormat" is_bitfield="true">
|
||||
Flag used to mark that the array uses 8 bone weights instead of 4.
|
||||
|
|
@ -4806,7 +4817,7 @@
|
|||
Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
|
||||
</constant>
|
||||
<constant name="LIGHT_PARAM_SHADOW_BIAS" value="15" enum="LightParam">
|
||||
Bias the shadow lookup to fix self-shadowing artifacts.
|
||||
Bias for the shadow lookup to fix self-shadowing artifacts.
|
||||
</constant>
|
||||
<constant name="LIGHT_PARAM_SHADOW_PANCAKE_SIZE" value="16" enum="LightParam">
|
||||
Sets the size of the directional shadow pancake. The pancake offsets the start of the shadow's camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to [code]0[/code] turns off the pancaking effect.
|
||||
|
|
@ -5021,17 +5032,17 @@
|
|||
Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will result in undersampling while values greater than [code]1.0[/code] will result in supersampling. A value of [code]1.0[/code] disables scaling.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_SCALING_3D_MODE_FSR" value="1" enum="ViewportScaling3DMode">
|
||||
Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will be result in the viewport being upscaled using FSR. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] disables scaling.
|
||||
Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will result in the viewport being upscaled using FSR. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] disables scaling.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_SCALING_3D_MODE_FSR2" value="2" enum="ViewportScaling3DMode">
|
||||
Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will be result in the viewport being upscaled using FSR2. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] will use FSR2 at native resolution as a TAA solution.
|
||||
Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will result in the viewport being upscaled using FSR2. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] will use FSR2 at native resolution as a TAA solution.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL" value="3" enum="ViewportScaling3DMode">
|
||||
Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will be result in the viewport being upscaled using MetalFX. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] disables scaling.
|
||||
Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will result in the viewport being upscaled using MetalFX. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] disables scaling.
|
||||
[b]Note:[/b] Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL" value="4" enum="ViewportScaling3DMode">
|
||||
Use MetalFX temporal upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will be result in the viewport being upscaled using MetalFX. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] will use MetalFX at native resolution as a TAA solution.
|
||||
Use MetalFX temporal upscaling for the viewport's 3D buffer. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less than [code]1.0[/code] will result in the viewport being upscaled using MetalFX. Values greater than [code]1.0[/code] are not supported and bilinear downsampling will be used instead. A value of [code]1.0[/code] will use MetalFX at native resolution as a TAA solution.
|
||||
[b]Note:[/b] Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_SCALING_3D_MODE_MAX" value="5" enum="ViewportScaling3DMode">
|
||||
|
|
@ -5183,10 +5194,11 @@
|
|||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_LIGHTING" value="2" enum="ViewportDebugDraw">
|
||||
Objects are displayed with only light information.
|
||||
[b]Note:[/b] When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_OVERDRAW" value="3" enum="ViewportDebugDraw">
|
||||
Objects are displayed semi-transparent with additive blending so you can see where they are drawing over top of one another. A higher overdraw (represented by brighter colors) means you are wasting performance on drawing pixels that are being hidden behind others.
|
||||
[b]Note:[/b] When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore.
|
||||
[b]Note:[/b] When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_WIREFRAME" value="4" enum="ViewportDebugDraw">
|
||||
Debug draw draws objects in wireframe.
|
||||
|
|
@ -5196,13 +5208,16 @@
|
|||
Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO" value="6" enum="ViewportDebugDraw">
|
||||
Objects are displayed with only the albedo value from [VoxelGI]s.
|
||||
Objects are displayed with only the albedo value from [VoxelGI]s. Requires at least one visible [VoxelGI] node that has been baked to have a visible effect.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING" value="7" enum="ViewportDebugDraw">
|
||||
Objects are displayed with only the lighting value from [VoxelGI]s.
|
||||
Objects are displayed with only the lighting value from [VoxelGI]s. Requires at least one visible [VoxelGI] node that has been baked to have a visible effect.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION" value="8" enum="ViewportDebugDraw">
|
||||
Objects are displayed with only the emission color from [VoxelGI]s.
|
||||
Objects are displayed with only the emission color from [VoxelGI]s. Requires at least one visible [VoxelGI] node that has been baked to have a visible effect.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS" value="9" enum="ViewportDebugDraw">
|
||||
Draws the shadow atlas that stores shadows from [OmniLight3D]s and [SpotLight3D]s in the upper left quadrant of the [Viewport].
|
||||
|
|
@ -5214,51 +5229,67 @@
|
|||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE" value="11" enum="ViewportDebugDraw">
|
||||
Draws the estimated scene luminance. This is a 1×1 texture that is generated when autoexposure is enabled to control the scene's exposure.
|
||||
[b]Note:[/b] Only supported when using the Forward+ or Mobile rendering methods.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_SSAO" value="12" enum="ViewportDebugDraw">
|
||||
Draws the screen space ambient occlusion texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have [member Environment.ssao_enabled] set in your [WorldEnvironment].
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_SSIL" value="13" enum="ViewportDebugDraw">
|
||||
Draws the screen space indirect lighting texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have [member Environment.ssil_enabled] set in your [WorldEnvironment].
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_PSSM_SPLITS" value="14" enum="ViewportDebugDraw">
|
||||
Colors each PSSM split for the [DirectionalLight3D]s in the scene a different color so you can see where the splits are. In order they will be colored red, green, blue, yellow.
|
||||
Colors each PSSM split for the [DirectionalLight3D]s in the scene a different color so you can see where the splits are. In order (from closest to furthest from the camera), they are colored red, green, blue, and yellow.
|
||||
[b]Note:[/b] When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
|
||||
[b]Note:[/b] Only supported when using the Forward+ or Mobile rendering methods.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_DECAL_ATLAS" value="15" enum="ViewportDebugDraw">
|
||||
Draws the decal atlas that stores decal textures from [Decal]s.
|
||||
[b]Note:[/b] Only supported when using the Forward+ or Mobile rendering methods.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_SDFGI" value="16" enum="ViewportDebugDraw">
|
||||
Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_SDFGI_PROBES" value="17" enum="ViewportDebugDraw">
|
||||
Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_GI_BUFFER" value="18" enum="ViewportDebugDraw">
|
||||
Draws the global illumination buffer ([VoxelGI] or SDFGI).
|
||||
Draws the global illumination buffer from [VoxelGI] or SDFGI. Requires [VoxelGI] (at least one visible baked VoxelGI node) or SDFGI ([member Environment.sdfgi_enabled]) to be enabled to have a visible effect.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_DISABLE_LOD" value="19" enum="ViewportDebugDraw">
|
||||
Disable mesh LOD. All meshes are drawn with full detail, which can be used to compare performance.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS" value="20" enum="ViewportDebugDraw">
|
||||
Draws the [OmniLight3D] cluster. Clustering determines where lights are positioned in screen-space, which allows the engine to only process these portions of the screen for lighting.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS" value="21" enum="ViewportDebugDraw">
|
||||
Draws the [SpotLight3D] cluster. Clustering determines where lights are positioned in screen-space, which allows the engine to only process these portions of the screen for lighting.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS" value="22" enum="ViewportDebugDraw">
|
||||
Draws the [Decal] cluster. Clustering determines where decals are positioned in screen-space, which allows the engine to only process these portions of the screen for decals.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES" value="23" enum="ViewportDebugDraw">
|
||||
Draws the [ReflectionProbe] cluster. Clustering determines where reflection probes are positioned in screen-space, which allows the engine to only process these portions of the screen for reflection probes.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_OCCLUDERS" value="24" enum="ViewportDebugDraw">
|
||||
Draws the occlusion culling buffer. This low-resolution occlusion culling buffer is rasterized on the CPU and is used to check whether instances are occluded by other objects.
|
||||
[b]Note:[/b] Only supported when using the Forward+ or Mobile rendering methods.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_MOTION_VECTORS" value="25" enum="ViewportDebugDraw">
|
||||
Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay.
|
||||
[b]Note:[/b] Only supported when using the Forward+ rendering method.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER" value="26" enum="ViewportDebugDraw">
|
||||
Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects.
|
||||
[b]Note:[/b] Only supported when using the Forward+ or Mobile rendering methods.
|
||||
</constant>
|
||||
<constant name="VIEWPORT_VRS_DISABLED" value="0" enum="ViewportVRSMode">
|
||||
Variable rate shading is disabled.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue