Add `shadow_caster_mask` to Light3D. #85338

EMBYRDEV · 2023-11-25T06:44:01Z

Implements godotengine/godot-proposals#3606 & godotengine/godot-proposals#8509

Tested on Forward+, Mobile & Compatibility renderers.

I feel this is a very useful change for optimisation when using dynamic shadows in projects and is required to provide a cheaper way of preventing lights bleeding into other rooms, even when they dont need detailed shadows otherwise.

This is more fine grained than just disabling shadows on the MeshInstances as you may want the ability for some lights to cast shadows for that object but not others.

See below, the SpotLight3D is set to only cast shadows for Layer 2. It defaults to existing behaviour (all layers that the light affects).

Production edit: This closes Add per-light shadow cull masks to control which objects cast shadows godot-proposals#3606.

EMBYRDEV · 2023-11-25T11:59:38Z

One point of discussion on this might be do we want this mask to be ANDed with the existing light cull mask (what we do in this PR) or if it should be entirely standalone to allow people setting certian meshes to not be lit by this light but will still cast shadows (I don't see many use cases for this).

drivers/gles3/storage/light_storage.cpp

EMBYRDEV · 2024-01-12T13:05:16Z

There seems to be a reasonable demand for this feature, any word on the reviews? Would love to make it into 4.3.

Calinou

Tested locally, it works as expected.

Testing project: test_shadow_caster_mask.zip

Example with the green object not casting shadows for the directional light only, and the purple OmniLight having a projector but not casting shadows for any objects:

Forward+

Mobile

Compatibility

Light projectors aren't supported when using Compatibility.

One point of discussion on this might be do we want this mask to be ANDed with the existing light cull mask (what we do in this PR) or if it should be entirely standalone to allow people setting certian meshes to not be lit by this light but will still cast shadows (I don't see many use cases for this).

I think the current behavior in this PR is fine; I can't think of any use cases for having an object not be lit by a light but still cast a shadow. We can revisit this later if there's enough demand.

Calinou · 2024-01-12T23:13:38Z

servers/rendering/rendering_server_default.h

@@ -376,6 +376,8 @@ class RenderingServerDefault : public RenderingServer {
 	FUNC2(light_set_cull_mask, RID, uint32_t)
 	FUNC5(light_set_distance_fade, RID, bool, float, float, float)
 	FUNC2(light_set_reverse_cull_face_mode, RID, bool)
+	FUNC2(light_set_shadow_caster_mask, RID, uint32_t)
+	FUNC1RC(uint32_t, light_get_shadow_caster_mask, RID)


Does this need to be exposed? Other light storage methods don't have a getter exposed, presumably to avoid pipeline stalls when the method is called.

cc @clayjohn

As @Calinou says for getters it is usually preferable to cache scene side and return that rather than query the servers, which can cause a sync and stall the pipeline.

AThousandShips · 2024-01-17T10:15:30Z

scene/3d/light_3d.cpp

@@ -354,6 +363,9 @@ void Light3D::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("set_shadow_reverse_cull_face", "enable"), &Light3D::set_shadow_reverse_cull_face);
 	ClassDB::bind_method(D_METHOD("get_shadow_reverse_cull_face"), &Light3D::get_shadow_reverse_cull_face);

+	ClassDB::bind_method(D_METHOD("set_shadow_caster_mask", "enable"), &Light3D::set_shadow_caster_mask);


Suggested change

ClassDB::bind_method(D_METHOD("set_shadow_caster_mask", "enable"), &Light3D::set_shadow_caster_mask);

ClassDB::bind_method(D_METHOD("set_shadow_caster_mask", "caster_mask"), &Light3D::set_shadow_caster_mask);

EMBYRDEV · 2024-03-04T11:38:45Z

NOTE: This isn't abandoned, I've just been sidetracked with other work in the meantime. I will revisit and incorporate feedback soon.

Mimisor7 · 2024-04-07T15:43:17Z

NOTE: This isn't abandoned, I've just been sidetracked with other work in the meantime. I will revisit and incorporate feedback soon.

Glad to hear that someone is working on this feature! I was just having problems with unwanted shadows cast from billboarded and shaded Sprite3Ds (that also appear to be self-shadowing...) in my 3D project, and I believe that this feature would likely resolve it.
I wish to see this feature implemented!

sebialex · 2024-05-18T02:40:14Z

Any chance we could get something like this for 2D lights?

EvanNoelGames · 2024-06-13T01:07:10Z

Very important feature I've been hoping for, really hope this makes it into 4.3!

Calinou · 2024-06-13T10:32:27Z

Any chance we could get something like this for 2D lights?

Maybe, but this should be requested in a proposal first as it's entirely separate functionality.

Very important feature I've been hoping for, really hope this makes it into 4.3!

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

If you need this feature right now, you can checkout the PR's branch and compile the editor and any export templates you might need for your project and specify them as custom export templates in the Export dialog.

EMBYRDEV · 2024-10-09T18:48:37Z

Any chance this will make it in for 4.4? Seems like everything has been addressed.

clayjohn · 2024-10-09T20:29:51Z

@EMBYRDEV I fully intend to merge this for 4.4! Sorry for my delay in reviewing

huwpascoe · 2024-10-24T01:40:06Z

Confirmed working including rebased.

clayjohn

Reviewed with the rendering team at today's rendering meeting and confirmed that the implementation is correct!

Sorry for the delay in reviewing

Repiteo · 2024-10-24T18:30:50Z

Thanks!

EMBYRDEV requested review from a team as code owners November 25, 2023 06:44

EMBYRDEV force-pushed the shadow-caster-mask branch from 514383e to 0e7577e Compare November 25, 2023 06:53

Calinou added enhancement topic:rendering topic:3d performance labels Nov 25, 2023

Calinou added this to the 4.x milestone Nov 25, 2023

AThousandShips reviewed Nov 26, 2023

View reviewed changes

drivers/gles3/storage/light_storage.cpp Outdated Show resolved Hide resolved

EMBYRDEV force-pushed the shadow-caster-mask branch from 0e7577e to f7a2e2d Compare November 26, 2023 11:21

EMBYRDEV changed the title ~~Add shadow_caster_mask to Light3D.~~ Add shadow_caster_mask to Light3D. Nov 26, 2023

EMBYRDEV requested a review from AThousandShips December 13, 2023 18:17

Calinou approved these changes Jan 12, 2024

View reviewed changes

Calinou reviewed Jan 12, 2024

View reviewed changes

akien-mga requested a review from clayjohn January 15, 2024 11:36

AThousandShips reviewed Jan 17, 2024

View reviewed changes

Calinou mentioned this pull request Feb 23, 2024

Option to offset spotlight cone start godotengine/godot-proposals#9157

Closed

Calinou mentioned this pull request May 7, 2024

Light3D's cull does not affect shadows #70556

Closed

clayjohn modified the milestones: 4.x, 4.4 Jul 24, 2024

EMBYRDEV requested review from a team as code owners August 11, 2024 21:53

dalexeev removed request for a team August 11, 2024 23:38

RAS-GIT mentioned this pull request Oct 5, 2024

Add Pull Requests that have been slowed down in the main branch. Redot-Engine/redot-engine#187

Open

clayjohn approved these changes Oct 24, 2024

View reviewed changes

Repiteo merged commit cfc05c5 into godotengine:master Oct 24, 2024
18 checks passed

Calinou mentioned this pull request Oct 31, 2024

Shadow Caster Mask does not affect LightmapGI baking for lights with Static bake mode #98684

Open

EMBYRDEV deleted the shadow-caster-mask branch November 11, 2024 14:22

tetrapod00 assigned tetrapod00 and unassigned tetrapod00 Nov 27, 2024

tetrapod00 mentioned this pull request Nov 27, 2024

Document Light3D shadow caster mask property godotengine/godot-docs#10326

Merged

merlang7 mentioned this pull request Jan 11, 2025

Add an "Invert Shadow Attenuation" option to Light3D nodes godotengine/godot-proposals#11540

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `shadow_caster_mask` to Light3D. #85338

Add `shadow_caster_mask` to Light3D. #85338

EMBYRDEV commented Nov 25, 2023 •

edited by Calinou

Loading

EMBYRDEV commented Nov 25, 2023

EMBYRDEV commented Jan 12, 2024

Calinou left a comment •

edited

Loading

Calinou Jan 12, 2024 •

edited

Loading

lawnjelly Jan 17, 2024

AThousandShips Jan 17, 2024

EMBYRDEV commented Mar 4, 2024

Mimisor7 commented Apr 7, 2024 •

edited

Loading

sebialex commented May 18, 2024

EvanNoelGames commented Jun 13, 2024

Calinou commented Jun 13, 2024 •

edited

Loading

EMBYRDEV commented Oct 9, 2024

clayjohn commented Oct 9, 2024

huwpascoe commented Oct 24, 2024

clayjohn left a comment

Repiteo commented Oct 24, 2024

	ClassDB::bind_method(D_METHOD("set_shadow_caster_mask", "enable"), &Light3D::set_shadow_caster_mask);
	ClassDB::bind_method(D_METHOD("set_shadow_caster_mask", "caster_mask"), &Light3D::set_shadow_caster_mask);

Add shadow_caster_mask to Light3D. #85338

Add shadow_caster_mask to Light3D. #85338

Conversation

EMBYRDEV commented Nov 25, 2023 • edited by Calinou Loading

EMBYRDEV commented Nov 25, 2023

EMBYRDEV commented Jan 12, 2024

Calinou left a comment • edited Loading

Choose a reason for hiding this comment

Forward+

Mobile

Compatibility

Calinou Jan 12, 2024 • edited Loading

Choose a reason for hiding this comment

lawnjelly Jan 17, 2024

Choose a reason for hiding this comment

AThousandShips Jan 17, 2024

Choose a reason for hiding this comment

EMBYRDEV commented Mar 4, 2024

Mimisor7 commented Apr 7, 2024 • edited Loading

sebialex commented May 18, 2024

EvanNoelGames commented Jun 13, 2024

Calinou commented Jun 13, 2024 • edited Loading

EMBYRDEV commented Oct 9, 2024

clayjohn commented Oct 9, 2024

huwpascoe commented Oct 24, 2024

clayjohn left a comment

Choose a reason for hiding this comment

Repiteo commented Oct 24, 2024

Add `shadow_caster_mask` to Light3D. #85338

Add `shadow_caster_mask` to Light3D. #85338

EMBYRDEV commented Nov 25, 2023 •

edited by Calinou

Loading

Calinou left a comment •

edited

Loading

Calinou Jan 12, 2024 •

edited

Loading

Mimisor7 commented Apr 7, 2024 •

edited

Loading

Calinou commented Jun 13, 2024 •

edited

Loading