[3.2] New CPU lightmapper #44628

JFonS · 2020-12-23T19:18:38Z

Completely re-write the lightmap generation code:

Follow the general lightmapper code structure from 4.0.
Use proper path tracing to compute the global illumination.
Use atlassing to merge all lightmaps into a single texture (done by @RandomShaper)
Use OpenImageDenoiser to improve the generated lightmaps.

There is some minor compatibility breakage in some properties and methods
in BakedLightmap, but lightmaps generated in previous engine versions
should work fine out of the box.

The scene importer has been changed to generate .unwrap_cache files
next to the imported scene files. These files SHOULD be added to any
version control system as they guarantee there won't be differences when
re-importing the scene from other OSes or engine versions.

Documentation is missing, I'll work on it after the holidays :)

This work started as a Google Summer of Code project; Was later funded by IMVU for a good amount of progress;
Was then finished and polished by me on my free time.

TPS demo with direct light only:

TPS demo with baked indirect lighting.

Special thanks to Pedro (@RandomShaper) for helping out with atlassing and other issues!

Supersedes #40035.
This closes #15055, closes #16820, closes #16398, closes #20321, closes #21587, closes #30789, closes #30929, closes #32746, closes #38685, closes #39532.

Edit:
I updated the PR with fixes for all the issues reported so far:

Fix Embree runtime when using MinGW (patch by @RandomShaper), closes New CPU lightmapper stuck at preparing data structures [MinGW GCC] #45097.
Fix baking of lightmaps on GridMaps, closes New CPU Lightmapper crashes with GridMap when baking #45086.
Fix some GLSL errors, should fix New CPU Lightmapper doesn't work on MacOS with IntelGPU #45091 but I don't have a proper way to test it on a mac.
Fix overflow in the number of shader variants (GLES2), it made gizmos go black. Reported via twitter, no issue open AFAIK.

NHodgesVFX · 2020-12-23T21:25:32Z

The light mapper works really well with the exception of dynamic objects, I couldn't seem to get them to work properly.

rough bake times with 10 bounces, environment light on scene, denoiser on, and capture on high. 20 cores 40 Threads at 2.2ghz, boost 3.1ghz. quality is acceptable on low.

ultra: 30secs
high: 18secs
medium: 12secs
low: 8secs

Here is a image from blender's cycles engine

Here is one in godot with this lightmapper, lights are set to indirect only.

here is with lights set to all

here is with no lights, the scene is lit with environment light only

with no indirect light.

with GIProbe

NHodgesVFX · 2020-12-23T21:42:10Z

Here is the scene
LightMapperTest.zip

dedm0zaj · 2020-12-24T02:39:08Z

In editor:

In game:

Project
test_lightmap_capture_energy_new.zip

upd:
Reimporting models helped

dedm0zaj · 2020-12-24T04:16:11Z

Test with my change (Energy parameter of DataLight affects dynamic objects)
#44458

gd_capture_energy_new.mp4

JFonS · 2020-12-24T12:01:12Z

@NHodgesVFX Do you have a reproduction project for the dynamic objects issue? I'm testing and everything seems to work fine for me.

JFonS · 2020-12-24T12:01:56Z

@dedm0zaj That's a separate issue, I will follow up on your PR soon.

NHodgesVFX · 2020-12-24T14:32:41Z

@NHodgesVFX Do you have a reproduction project for the dynamic objects issue? I'm testing and everything seems to work fine for me.

i was trying to get it to work with the cornel's box scene above. This is what it looks like. Im wondering if its a scale issue. I just set the two small sphere to be dynamic. Here is the scene as it is in the photo
CornelBox_Dynamic.zip

NHodgesVFX · 2020-12-24T14:56:31Z

Update it does seem to be a scale issue, is it possible to get the cell size slider to go smaller? I scaled up the scene 5x and that made it work. Something I noticed is it might be nice to exaggerate the GI, although I would worry about that later.

JFonS · 2020-12-24T15:46:24Z

@NHodgesVFX I set a lower bound to the cell size because the amount of stored data can grow pretty quickly, but it can be lowered.

As per the exaggeration, @dedm0zaj is working on a change so that the "Energy" property of BakedLightmapData also affects dynamics objects, so that should do fine.

NHodgesVFX · 2020-12-24T15:48:32Z

@NHodgesVFX I set a lower bound to the cell size because the amount of stored data can grow pretty quickly, but it can be lowered.

As per the exaggeration, @dedm0zaj is working on a change so that the "Energy" property of BakedLightmapData also affects dynamics objects, so that should do fine.

I unbounded the values or at least i think i did, about to try it now.

NHodgesVFX · 2020-12-24T15:58:27Z

Ok im at a loss, it doesn't work, the scene I listed above for whatever reason doesn't work. It does seem like the unbounded capture size worked fine though judging by bake time and size. Probably best if you give it a check when you have the chance. Although its Christmas now, so take a break :) Happy Holidays

JFonS · 2020-12-24T16:03:41Z

@NHodgesVFX I will get back to this after the break then, happy holidays to you too!

esblinuxcss · 2020-12-26T17:35:16Z

Completely re-write the lightmap generation code:

Follow the general lightmapper code structure from 4.0.

Use proper path tracing to compute the global illumination.

Use atlassing to merge all lightmaps into a single texture (done by @RandomShaper)

Use OpenImageDenoiser to improve the generated lightmaps.

There is some minor compatibility breakage in some properties and methods
in BakedLightmap, but lightmaps generated in previous engine versions
should work fine out of the box.

The scene importer has been changed to generate .unwrap_cache files
next to the imported scene files. These files SHOULD be added to any
version control system as they guarantee there won't be differences when
re-importing the scene from other OSes or engine versions.

Documentation is missing, I'll work on it after the holidays :)

This work started as a Google Summer of Code project; Was later funded by IMVU for a good amount of progress;
Was then finished and polished by me on my free time.

TPS demo with direct light only:

TPS demo with baked indirect lighting.

Special thanks to Pedro (@RandomShaper) for helping out with atlassing and other issues!

Supersedes #40035.
This closes #15055, closes #16820, closes #16398, closes #20321, closes #21587, closes #30789, closes #30929, closes #32746, closes #38685, closes #39532.

I try to bake a small screne created with Qodot Plugin it take very longer time(3 and a half hours) to bake the scre with 4 Lights15 bounces in high quality my pc is not a power house is laptop with 1.66 Ghz Dual Core AMD CPU with 8Gb of RAM the current Ligthmapper takes 7-12minutes to bake the scne (using come trace and the ligths are set in Bake All) i will try to make another test with a more small scene created in blender with one ligth. when i do that i will show the results

NHodgesVFX · 2020-12-26T17:47:48Z

@esblinuxcss this is expected, the cone tracing mode of the previous light mapper was a fast but inaccurate mode based off of GiProbe. The new lightmapper uses a much better version of the raytrace mode of the previous lightmapper. In addition you are using 15 bounces the previous lightmapper only used 1, more bounces more time. Also Highquality mode takes more time,you should be able to get an acceptable result with low. Try it on low with 3 bounces.

Make sure you are building with target=release_debug or you are downloading an artifact from here which is compiled using release_debug.

Calinou · 2020-12-26T18:25:11Z

@esblinuxcss We could consider adding an easy way to bake with a "preview" quality before committing to a "final" bake. This way, you could keep your current settings in your BakedLightmap node, yet you'd have the ability to perform a quick bake with low quality settings.

I opened a proposal to discuss this: godotengine/godot-proposals#2029

Avogine · 2020-12-29T10:11:15Z

I've got a question regarding draw calls. When using baked light, it seems like every object with baked light is adding 1 extra draw call. How are you supposed to optimize a forest with hundreds of trees, for example, where you would normally use multimeshes?

akien-mga · 2020-12-29T15:27:11Z

core/math/geometry.cpp

+#define STB_RECT_PACK_IMPLEMENTATION
+#include "thirdparty/stb_rect_pack/stb_rect_pack.h"


Nitpick as it's preexisting code, but please add a separation line between Godot headers ("core/print_string.h") and thirdparty/system headers.

reduz · 2020-12-29T15:27:12Z

@Avogine you just don't use lightmaps for such kind of scenes. For outdoors, you will have to wait for Godot 4 SDFGI, or just not use them.

Avogine · 2020-12-29T15:28:22Z

Ok thanks, good to know

akien-mga · 2020-12-29T15:29:11Z

thirdparty/stb_rect_pack/stb_rect_pack.h

@@ -0,0 +1,629 @@
+// stb_rect_pack.h - v1.00 - public domain - rectangle packing


This can go in thirdparty/misc/ like other stb headers, and like done in master.

~~Also make sure to document it in thirdparty/README.md (under "Misc / Modules", you can copy from stb_vorbis.c and adjust).~~
Edit: That's done already, I had missed the file.

akien-mga · 2020-12-29T15:32:18Z

modules/denoise/denoise_wrapper.cpp

+#include "denoise_wrapper.h"
+#include "core/os/copymem.h"
+#include "core/os/memory.h"
+#include "thirdparty/oidn/include/OpenImageDenoise/oidn.h"
+#include <stdio.h>


Suggested change

#include "denoise_wrapper.h"

#include "core/os/copymem.h"

#include "core/os/memory.h"

#include "thirdparty/oidn/include/OpenImageDenoise/oidn.h"

#include <stdio.h>

#include "denoise_wrapper.h"

#include "core/os/copymem.h"

#include "core/os/memory.h"

#include "thirdparty/oidn/include/OpenImageDenoise/oidn.h"

#include <stdio.h>

See https://docs.godotengine.org/en/latest/community/contributing/code_style_guidelines.html#header-includes

Note that normally you shouldn't include thirdparty headers with a fully qualified path like this, it would be better to add them to the include path and use #include <OpenImageDenoise/oidn.h>. But given that it's done the same way in master, no need to change it there. One day I'll get to allow unbundling this dependency on Linux distros and that will be part of it).

JFonS · 2021-01-14T18:27:14Z

I updated the PR with fixes for all the issues reported so far:

Fix Embree runtime when using MinGW (patch by @RandomShaper), closes New CPU lightmapper stuck at preparing data structures [MinGW GCC] #45097.
Fix baking of lightmaps on GridMaps, closes New CPU Lightmapper crashes with GridMap when baking #45086.
Fix some GLSL errors, should fix New CPU Lightmapper doesn't work on MacOS with IntelGPU #45091 but I don't have a proper way to test it on a mac.
Fix overflow in the number of shader variants (GLES2), it made gizmos go black. Reported via twitter, no issue open AFAIK.

clayjohn · 2021-01-14T20:20:52Z

Changes to shader compiler look good! I havent reviewed anything else, but I trust the above reviews are sufficient in that regard.

@RandomShaper

- Fix Embree runtime when using MinGW (patch by @RandomShaper). - Fix baking of lightmaps on GridMaps. - Fix some GLSL errors. - Fix overflow in the number of shader variants (GLES2).

akien-mga

Let's get this merged :)

akien-mga · 2021-01-15T12:25:55Z

Thanks for the amazing work!

Jummit · 2021-01-16T17:30:18Z

@JFonS You forgot to add documentation for the new settings. Most of them are pretty obvious, but I bet there are some things that are good to know, but only you are aware of.

Also, is there a reason why max_atlas_size has a minimum value of 2053?

Calinou · 2021-01-17T02:15:28Z

@Jummit Doesn't #44628 cover the documentation?

Jummit · 2021-01-17T09:52:23Z

@Jummit Doesn't #44628 cover the documentation?

Weird, it looks like it, but they don't appear in the documentation in my build. Probably a mistake on my end.

JFonS added enhancement topic:rendering labels Dec 23, 2020

JFonS added this to the 3.2 milestone Dec 23, 2020

JFonS requested review from akien-mga and reduz as code owners December 23, 2020 19:18

JFonS mentioned this pull request Dec 23, 2020

[3.2] Add new CPU lightmapper #40035

Closed

clayjohn requested a review from lawnjelly December 23, 2020 19:49

This was referenced Dec 26, 2020

Add a "Preview Bake" button for LightmapGI for quick preview bakes godotengine/godot-proposals#2029

Open

BakedLightmap Crash #44760

Closed

akien-mga reviewed Dec 29, 2020

View reviewed changes

CPU lightmapper formatting and minor fixes.

7d7d7ef

JFonS force-pushed the new_cpu_lightmapper_3.2 branch 3 times, most recently from d85b315 to ff40fa3 Compare January 14, 2021 18:08

JFonS added 2 commits January 15, 2021 12:31

Add documentation for new CPU lightmapper.

d909592

CPU lightmapper fixes.

b1ca82c

- Fix Embree runtime when using MinGW (patch by @RandomShaper). - Fix baking of lightmaps on GridMaps. - Fix some GLSL errors. - Fix overflow in the number of shader variants (GLES2).

JFonS force-pushed the new_cpu_lightmapper_3.2 branch from ff40fa3 to b1ca82c Compare January 15, 2021 11:34

akien-mga approved these changes Jan 15, 2021

View reviewed changes

akien-mga merged commit 497653a into godotengine:3.2 Jan 15, 2021

Calinou mentioned this pull request Jan 18, 2021

Implement grayscale lightmap baking to decrease memory usage and storage requirements godotengine/godot-proposals#2142

Closed

Janders1800 mentioned this pull request Jan 19, 2021

Disconection betwen Gizmo and inspector values on BakedLightmap #45317

Closed

qarmin mentioned this pull request Jan 21, 2021

Godot crashes during lightmap generation #30789

Closed

This was referenced Jan 22, 2021

RayTrace is much darker than ConeTrace with BakedLightmap #15055

Closed

Make the lightmap render result affected by the WorldEnvironment. #16398

Closed

Calinou mentioned this pull request Feb 19, 2021

BakedLightmap shadows looks highly pixelated when using ConeTrace and simply incorrect when using RayTrace #30929

Closed

Calinou mentioned this pull request Feb 27, 2021

Baked Lighting #20321

Closed

akien-mga modified the milestones: 3.2, 3.3 Apr 20, 2021

This was referenced Apr 28, 2021

Lightmap (raytrace) not working? #16820

Closed

Dynamic lighting missing/broken on some meshes #21587

Closed

Generated UV2s are not saved #32746

Closed

BakedLightmap crash on large scenes #38685

Closed

JFonS deleted the new_cpu_lightmapper_3.2 branch May 4, 2021 07:41

Calinou mentioned this pull request Oct 16, 2021

Save Scene take much longer, with the progression bar stucked in 100%, using baked lightmaps. #24793

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3.2] New CPU lightmapper #44628

[3.2] New CPU lightmapper #44628

JFonS commented Dec 23, 2020 •

edited

Loading

NHodgesVFX commented Dec 23, 2020 •

edited

Loading

NHodgesVFX commented Dec 23, 2020

dedm0zaj commented Dec 24, 2020 •

edited

Loading

dedm0zaj commented Dec 24, 2020

JFonS commented Dec 24, 2020

JFonS commented Dec 24, 2020

NHodgesVFX commented Dec 24, 2020

NHodgesVFX commented Dec 24, 2020

JFonS commented Dec 24, 2020

NHodgesVFX commented Dec 24, 2020

NHodgesVFX commented Dec 24, 2020

JFonS commented Dec 24, 2020

esblinuxcss commented Dec 26, 2020

NHodgesVFX commented Dec 26, 2020 •

edited

Loading

Calinou commented Dec 26, 2020 •

edited

Loading

Avogine commented Dec 29, 2020 •

edited

Loading

akien-mga Dec 29, 2020

reduz commented Dec 29, 2020

Avogine commented Dec 29, 2020

akien-mga Dec 29, 2020 •

edited

Loading

akien-mga Dec 29, 2020

JFonS commented Jan 14, 2021

clayjohn commented Jan 14, 2021

akien-mga left a comment

akien-mga commented Jan 15, 2021

Jummit commented Jan 16, 2021 •

edited

Loading

Calinou commented Jan 17, 2021 •

edited

Loading

Jummit commented Jan 17, 2021

		#define STB_RECT_PACK_IMPLEMENTATION
		#include "thirdparty/stb_rect_pack/stb_rect_pack.h"

		@@ -0,0 +1,629 @@
		// stb_rect_pack.h - v1.00 - public domain - rectangle packing

[3.2] New CPU lightmapper #44628

[3.2] New CPU lightmapper #44628

Conversation

JFonS commented Dec 23, 2020 • edited Loading

NHodgesVFX commented Dec 23, 2020 • edited Loading

NHodgesVFX commented Dec 23, 2020

dedm0zaj commented Dec 24, 2020 • edited Loading

dedm0zaj commented Dec 24, 2020

JFonS commented Dec 24, 2020

JFonS commented Dec 24, 2020

NHodgesVFX commented Dec 24, 2020

NHodgesVFX commented Dec 24, 2020

JFonS commented Dec 24, 2020

NHodgesVFX commented Dec 24, 2020

NHodgesVFX commented Dec 24, 2020

JFonS commented Dec 24, 2020

esblinuxcss commented Dec 26, 2020

NHodgesVFX commented Dec 26, 2020 • edited Loading

Calinou commented Dec 26, 2020 • edited Loading

Avogine commented Dec 29, 2020 • edited Loading

akien-mga Dec 29, 2020

Choose a reason for hiding this comment

reduz commented Dec 29, 2020

Avogine commented Dec 29, 2020

akien-mga Dec 29, 2020 • edited Loading

Choose a reason for hiding this comment

akien-mga Dec 29, 2020

Choose a reason for hiding this comment

JFonS commented Jan 14, 2021

clayjohn commented Jan 14, 2021

akien-mga left a comment

Choose a reason for hiding this comment

akien-mga commented Jan 15, 2021

Jummit commented Jan 16, 2021 • edited Loading

Calinou commented Jan 17, 2021 • edited Loading

Jummit commented Jan 17, 2021

JFonS commented Dec 23, 2020 •

edited

Loading

NHodgesVFX commented Dec 23, 2020 •

edited

Loading

dedm0zaj commented Dec 24, 2020 •

edited

Loading

NHodgesVFX commented Dec 26, 2020 •

edited

Loading

Calinou commented Dec 26, 2020 •

edited

Loading

Avogine commented Dec 29, 2020 •

edited

Loading

akien-mga Dec 29, 2020 •

edited

Loading

Jummit commented Jan 16, 2021 •

edited

Loading

Calinou commented Jan 17, 2021 •

edited

Loading