Skip to content

Update HDR output manual page based on the 4.7 dev cycle#11920

Merged
mhilbrunner merged 1 commit into
godotengine:masterfrom
allenwp:hdr-output-manual-tonemap-update
Apr 11, 2026
Merged

Update HDR output manual page based on the 4.7 dev cycle#11920
mhilbrunner merged 1 commit into
godotengine:masterfrom
allenwp:hdr-output-manual-tonemap-update

Conversation

@allenwp
Copy link
Copy Markdown
Contributor

@allenwp allenwp commented Apr 10, 2026

What problem(s) does this PR solve?

What is the rationale for the approach used in this PR?

This PR addresses the some of the same points as #11903 (removes trailing whitespace, adds requirement for mobile or forward+ renderer), but intentionally does not add the "On Linux/*BSD, HDR output is not supported on X11 due to display server limitations" comment to these instructions. My opinion is that these initial setup instructions have a lot of text, so adding more explanation to them makes for a more difficult user experience when configuring a project to use HDR output. In short, I take the stance that "less is more" for this list.

This PR also removes the comment about macOS needing the metal driver, as this is no longer the case.

This PR adds instruction relating to new changes to the editor introduced in godotengine/godot#118079 and updates the example GDScript to use the signals added by godotengine/godot#115666 and godotengine/godot#118076

Most importantly, I have reworked the guidance for when to use Window.get_output_max_linear_value() to address #11913.

I have not yet included any comments about how to adjust system reference/max luminance. Of specific importance is how Windows laptops behave, which is bonkers. I'll add this information in a followup PR sometime before 4.7 stable, but it is not necessary for beta 1.

Was AI used to create a portion of this PR?

No.

Are there any parts of this PR that you are uncertain of or require special attention from reviewers?

Much of these changes are required before godotengine/godot-website#1302 goes live.

Depends on:

@allenwp allenwp added this to the 4.7 milestone Apr 10, 2026
@allenwp allenwp added enhancement topic:rendering area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Apr 10, 2026
@allenwp allenwp marked this pull request as ready for review April 10, 2026 21:11
@allenwp allenwp requested review from a team as code owners April 10, 2026 21:11
@allenwp
Copy link
Copy Markdown
Contributor Author

allenwp commented Apr 10, 2026

Whoops, I forgot to add the note that HDR output is not currently supported on Android. I’ll add that to this PR sometime next week (I’m back in the office on Tuesday). Adding this note won’t affect the rest of this PR, so it’s still ready for review.

Copy link
Copy Markdown
Member

@Calinou Calinou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@mhilbrunner mhilbrunner merged commit d6fe987 into godotengine:master Apr 11, 2026
1 check passed
@mhilbrunner
Copy link
Copy Markdown
Member

Thank you! Merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:rendering

Projects

None yet

Development

Successfully merging this pull request may close these issues.

HDR output: No warning against using emissive with max linear value

3 participants