Просмотр исходного кода

Merge pull request #58291 from Calinou/doc-voxelgi-procedural-bake-deferred

Document that meshes and lights must be fully set up before baking VoxelGI
Rémi Verschelde 3 лет назад
Родитель
Сommit
dfa5c5db12
1 измененных файлов с 1 добавлено и 0 удалено
  1. 1 0
      doc/classes/VoxelGI.xml

+ 1 - 0
doc/classes/VoxelGI.xml

@@ -21,6 +21,7 @@
 			<description>
 				Bakes the effect from all [GeometryInstance3D]s marked with [constant GeometryInstance3D.GI_MODE_STATIC] and [Light3D]s marked with either [constant Light3D.BAKE_STATIC] or [constant Light3D.BAKE_DYNAMIC]. If [code]create_visual_debug[/code] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [VoxelGI]'s data and debug any issues that may be occurring.
 				[b]Note:[/b] [method bake] works from the editor and in exported projects. This makes it suitable for procedurally generated or user-built levels. Baking a [VoxelGI] node generally takes from 5 to 20 seconds in most scenes. Reducing [member subdiv] can speed up baking.
+				[b]Note:[/b] [GeometryInstance3D]s and [Light3D]s must be fully ready before [method bake] is called. If you are procedurally creating those and some meshes or lights are missing from your baked [VoxelGI], use [code]call_deferred("bake")[/code] instead of calling [method bake] directly.
 			</description>
 		</method>
 		<method name="debug_bake">