godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.95k stars 3.23k forks source link

Viewport "use_hdr_2d" documentation point unclear #10044

Open RichMakeGame opened 1 month ago

RichMakeGame commented 1 month ago

Your Godot version: 4.3 Issue description:

in the description of "use_hdr_2d" there is the following sentence: "Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen)"

I can't find reference anywhere in the documents about the concept of attaching a Viewport or SubViewport to the screen. The closest I have found is in the 3.2 docs Viewport.set_attach_to_screen_rect. Please could this point be clarified? What defines a viewport as being 'attached to the screen'? thanks!

URL to the documentation page: https://docs.godotengine.org/en/stable/classes/class_viewport.html#class-viewport

clayjohn commented 1 month ago

Good point

A Viewport is attached to the screen if viewport_attach_to_screen has been called with it, or if it is a root Viewport (in which case viewport_attach_to_screen() is called internally).