Improve Texture*RD, RenderData and LightmapperRD class documentation #107326
+27
−16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Calinou
commented
Jun 9, 2025
Calinou
commented
- Link to compute texture demo in Texture*RD class documentation.
- Link to related classes in RenderData/RenderSceneData/RenderSceneBuffers.
- Clarify requirements for baking lightmaps in LightmapperRD.
Calinou
added
enhancement
documentation
cherrypick:4.4
Mickeon
reviewed
Jun 10, 2025
- Link to compute texture demo in Texture*RD class documentation. - Link to related classes in RenderData/RenderSceneData/RenderSceneBuffers. - Clarify requirements for baking lightmaps in LightmapperRD.
Mickeon
reviewed
Jun 12, 2025
| @@ -5,7 +5,7 @@ | |||
| </brief_description> | |||
| <description> | |||
| LightmapperRD ("RD" stands for [RenderingDevice]) is the built-in GPU-based lightmapper for use with [LightmapGI]. On most dedicated GPUs, it can bake lightmaps much faster than most CPU-based lightmappers. LightmapperRD uses compute shaders to bake lightmaps, so it does not require CUDA or OpenCL libraries to be installed to be usable. | |||
| [b]Note:[/b] Only usable when using the RenderingDevice backend (Forward+ or Mobile renderers), not Compatibility. | |||
| [b]Note:[/b] This lightmapper requires the GPU to support the [RenderingDevice] backend (Forward+ or Mobile renderers). When using the Compatibility renderer, baking will use a temporary [RenderingDevice]. [i]Rendering[/i] lightmaps that were already baked beforehand does not require support for RenderingDevice. | |||
There was a problem hiding this comment.
One was changed to a link but the other wasn't. Also, maybe the following flows better?
Suggested change
| [b]Note:[/b] This lightmapper requires the GPU to support the [RenderingDevice] backend (Forward+ or Mobile renderers). When using the Compatibility renderer, baking will use a temporary [RenderingDevice]. [i]Rendering[/i] lightmaps that were already baked beforehand does not require support for RenderingDevice. | |
| [b]Note:[/b] This lightmapper requires the GPU to support the [RenderingDevice] backend (Forward+ or Mobile renderers). When using the Compatibility renderer, baking will use a temporary [RenderingDevice]. Support for [RenderingDevice] is not required to [i]render[/i] lightmaps that were already baked beforehand. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.