Expose runtime baking functionality in LightmapGI #91676

RisingThumb · 2024-05-07T19:54:20Z

This will resolve #59217
This partially resolves godotengine/godot-proposals#8656 . It exposes bake() for scripting, however there isn't any cancelling or aborting yet. ~~Additionally it does not currently work for exported projects.~~ It also works for exported projects

Implementation notes:

As .exr files cannot be imported at runtime, I save as a .res. This is also because when the lightmapper is available in exported projects, we can use .res files, while we can't save .exr files
The radiance changes setting to Radiance 128, and then resetting back to what it was, is because the lightmaps were not generating correctly at runtime using the Scene/Custom Sky environment options. Setting it to 128 fixes this. I am not sure what is causing this, possibly something related to environment_bake_panorama or sky_bake_panorama. There is a related Size2i parameter for this radiance size, but setting that to 256 while using a radiance size of 256 doesn't fix this issue.
Is there a better way of converting from an image to a texturelayered?

This can only be used in editor plugins or when running an editor build. In an exported project, this functionality is not currently available.

jcostello · 2024-05-08T04:16:29Z

In which cases you will bake lightmap in runtime?

passivestar · 2024-05-08T09:36:37Z

In which cases you will bake lightmap in runtime?

In custom level editors built with godot

Also when reimporting levels in godot while the game is running. Here's me taking advantage of the fact that VoxelGI can be baked at runtime: https://twitter.com/passivestar_/status/1780433192211612039

RisingThumb · 2024-05-08T10:20:25Z

In which cases you will bake lightmap in runtime?

This opens up the opportunity for having a script that goes through all your maps/scenes and baking these lightmaps, rather than doing it in-editor, since the editor process is manual currently. So if you want a lot of high quality lightmaps for a lot of scenes, you can go away and do something else in the meantime. Additionally, it also opens it up for custom map makers in a similar way to Quake, where the lightmaps need to be baked(however this would require additional work for it to work in exports).

Note that bake() will still not work in exported projects, as lightmapping and automatic UV unwrapping (xatlas) functionality is only available in the editor to decrease binary size. bake() will only work in projects run from the editor, as well as the editor itself.

That said this is currently for runtime with the editor, not currently in exported builds(quoted from #59217 ), so it doesn't get us all the way there yet, but at least to the same state Godot 3.X was at which for projects like func_godot, is still very helpful

nklbdev · 2024-05-13T09:23:13Z

I'm joining the topicstarter.

I'm creating an engine for a game based on Godot, but the maps are outside the resource file system. They are located in the next folder with the executable file. They are created in TrenchBroom (*.map-files). I use my own parser for these files. Not Quodot and not func_godot. To build them, I call the game executable file via the command line:

> game.exe --headless -- build path/to/file.map

Here a packed scene is created and saved to another external *.scn-file. The scene stores the geometry, light, physics and location of the player, monsters, game objects as well as the conditions for switching to another map. The map file does not embed textures, materials and internal details of game objects.
Everything goes fine and after that the scene can be opened and played.

I really miss the ability to bake light in map building script.

Calinou · 2024-05-13T16:29:49Z

Please discuss the feature itself in the proposal, as comments on the pull request should only refer to the implementation.

sourcelocation · 2024-07-23T19:41:10Z

Hi, I tried compiling this fork and I was surprised to find that the exported project (at least the debug build, haven't checked release yet) actually can bake lightmaps into .res file format, however they don't look right. I assume it's due to slice counts. The first screenshot is a lightmap compiled from within the editor, and the second is from the game.

(Temporarily disabled denoiser)

What leads me to believe this is an issue with slices is the fact that if I change the vertical slice count from 2 to 1, I get a rather similar broken lightmap to the one I got while baking in the game.

As there aren't any import options for .res files, I'm not sure what the issue could be here. I want to contribute, I just can't figure out this problem. Do you have an idea by any chance @Calinou?

sourcelocation · 2024-07-25T14:11:01Z

Update: I got it working in the exported project here RisingThumb#1. This is my first ever contribution to the Godot's codebase, so probably a lot of things are wrong there. I need some assistance.

Expose runtime baking functionality in LightmapGI

RisingThumb · 2024-07-26T21:31:04Z

Thanks @sourcelocation , I've merged your changes into this PR which make it possible to bake at runtime for exported projects into this PR. Also means it addresses the original issue more completely now, as it works for exported projects if module_lightmapper_rd_enabled and module_xatlas_unwrap_enabled are enabled 👍

sourcelocation · 2024-07-28T16:42:27Z

When can we expect this PR to be reviewed?

Calinou · 2024-07-28T16:50:32Z

When can we expect this PR to be reviewed?

4.3 is in feature freeze, so new features can only be merged in 4.4 at the earliest.

Also, there are merge conflicts that should be resolved. See Pull request workflow for instructions 🙂

Calinou · 2024-07-28T16:51:33Z

doc/classes/LightmapGI.xml

+				Bakes lightmaps (requires meshes to have UV2 unwrapped) for [param from_node] and its children to [param image_data_path]. [param image_data_path] must end with an [code].exr[/code] or [code].lmbake[/code] file extension. If [param from_node] is [code]null[/code], lightmaps are baked from the [LightmapGI] node's parent. Baking lightmaps can take from a few seconds to several dozen minutes depending on the GPU speed and quality settings chosen.
+				[b]Note:[/b] [method bake] only works within the editor, and when running a project from the editor. [method bake] will do nothing when called in a project exported in either debug or release mode. This limitation is in place to reduce the binary size of exported projects.


Suggested change

Bakes lightmaps (requires meshes to have UV2 unwrapped) for [param from_node] and its children to [param image_data_path]. [param image_data_path] must end with an [code].exr[/code] or [code].lmbake[/code] file extension. If [param from_node] is [code]null[/code], lightmaps are baked from the [LightmapGI] node's parent. Baking lightmaps can take from a few seconds to several dozen minutes depending on the GPU speed and quality settings chosen.

[b]Note:[/b] [method bake] only works within the editor, and when running a project from the editor. [method bake] will do nothing when called in a project exported in either debug or release mode. This limitation is in place to reduce the binary size of exported projects.

Bakes lightmaps (requires meshes to have UV2 unwrapped) for [param from_node] and its children to [param image_data_path]. [param image_data_path] must end with an [code].exr[/code] or [code].lmbake[/code] file extension. If [param from_node] is [code]null[/code], lightmaps are baked from the [LightmapGI] node's parent. Baking lightmaps can take from a few seconds to several dozen minutes depending on the GPU speed and quality settings chosen.

[b]Note:[/b] [method bake] only works within the editor, and when running a project from the editor. [method bake] will do nothing when called in a project exported in either debug or release mode. This limitation is in place to reduce the binary size of exported projects. You can [url=$DOCS_URL/contributing/development/compiling/index.html]compile custom export templates[/url] with the [code]module_lightmapper_rd_enabled=yes module_xatlas_unwrap_enabled=yes[/code] SCons options to remove this limitation.

Calinou · 2024-07-28T16:52:38Z

modules/lightmapper_rd/config.py

+    envvars = Variables()
+    envvars.Add(
+        BoolVariable(
+            "lightmapper_rd",
+            "Enable Lightmapper functionality in export template builds (increases binary size)",
+            False,
+        )
+    )


I'm confused why we need a separate lightmapper_rd option for this, considering we already have module_lightmapper_rd_enabled option that is True by default in editor builds and False by default in export template builds.

See also #73003.

Calinou · 2024-07-28T16:53:14Z

modules/xatlas_unwrap/config.py

+    envvars = Variables()
+    envvars.Add(
+        BoolVariable(
+            "xatlas_unwrap",
+            "Enable xatlas unwrapping functionality in export template builds (increases binary size)",
+            False,
+        )
+    )


Same as above.

Will work on it! Thanks.

AThousandShips · 2024-07-31T07:38:47Z

@RisingThumb please confirm you have abandoned this PR

RisingThumb · 2024-07-31T11:44:59Z

Hi, I'm happy for this PR to be superseded by #94965

Expose runtime baking functionality in LightmapGI

7f02383

This can only be used in editor plugins or when running an editor build. In an exported project, this functionality is not currently available.

RisingThumb requested review from a team as code owners May 7, 2024 19:54

Calinou added enhancement topic:rendering topic:3d labels May 7, 2024

Calinou added this to the 4.x milestone May 7, 2024

sourcelocation added 4 commits July 25, 2024 12:36

Fix slicing issue

e05ce18

Update lightmap_gi.cpp

8a314b9

clang-format

69cf82e

lightmapper_rd and xatlas_unwrap build options

b61154f

sourcelocation and others added 2 commits July 25, 2024 17:21

formatting

2ba1449

Merge pull request #1 from sourcelocation/expose-lightmap-baking

492b447

Expose runtime baking functionality in LightmapGI

RisingThumb requested a review from a team as a code owner July 26, 2024 21:27

Calinou reviewed Jul 28, 2024

View reviewed changes

sourcelocation mentioned this pull request Jul 30, 2024

Expose runtime baking functionality in LightmapGI #94965

Closed

RisingThumb closed this Jul 31, 2024

AThousandShips added the archived label Jul 31, 2024

AThousandShips removed this from the 4.x milestone Jul 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose runtime baking functionality in LightmapGI #91676

Expose runtime baking functionality in LightmapGI #91676

RisingThumb commented May 7, 2024 •

edited

Loading

jcostello commented May 8, 2024

passivestar commented May 8, 2024

RisingThumb commented May 8, 2024 •

edited

Loading

nklbdev commented May 13, 2024

Calinou commented May 13, 2024 •

edited

Loading

sourcelocation commented Jul 23, 2024

sourcelocation commented Jul 25, 2024

RisingThumb commented Jul 26, 2024

sourcelocation commented Jul 28, 2024

Calinou commented Jul 28, 2024

Calinou Jul 28, 2024 •

edited

Loading

Calinou Jul 28, 2024 •

edited

Loading

Calinou Jul 28, 2024

sourcelocation Jul 28, 2024

AThousandShips commented Jul 31, 2024

RisingThumb commented Jul 31, 2024

		Bakes lightmaps (requires meshes to have UV2 unwrapped) for [param from_node] and its children to [param image_data_path]. [param image_data_path] must end with an [code].exr[/code] or [code].lmbake[/code] file extension. If [param from_node] is [code]null[/code], lightmaps are baked from the [LightmapGI] node's parent. Baking lightmaps can take from a few seconds to several dozen minutes depending on the GPU speed and quality settings chosen.
		[b]Note:[/b] [method bake] only works within the editor, and when running a project from the editor. [method bake] will do nothing when called in a project exported in either debug or release mode. This limitation is in place to reduce the binary size of exported projects.

Expose runtime baking functionality in LightmapGI #91676

Expose runtime baking functionality in LightmapGI #91676

Conversation

RisingThumb commented May 7, 2024 • edited Loading

jcostello commented May 8, 2024

passivestar commented May 8, 2024

RisingThumb commented May 8, 2024 • edited Loading

nklbdev commented May 13, 2024

Calinou commented May 13, 2024 • edited Loading

sourcelocation commented Jul 23, 2024

sourcelocation commented Jul 25, 2024

RisingThumb commented Jul 26, 2024

sourcelocation commented Jul 28, 2024

Calinou commented Jul 28, 2024

Calinou Jul 28, 2024 • edited Loading

Choose a reason for hiding this comment

Calinou Jul 28, 2024 • edited Loading

Choose a reason for hiding this comment

Calinou Jul 28, 2024

Choose a reason for hiding this comment

sourcelocation Jul 28, 2024

Choose a reason for hiding this comment

AThousandShips commented Jul 31, 2024

RisingThumb commented Jul 31, 2024

RisingThumb commented May 7, 2024 •

edited

Loading

RisingThumb commented May 8, 2024 •

edited

Loading

Calinou commented May 13, 2024 •

edited

Loading

Calinou Jul 28, 2024 •

edited

Loading

Calinou Jul 28, 2024 •

edited

Loading