Merge pull request #101818 from Yelloween10/update-subviewport-doc

Update SubViewport documentations to include a note about input behaviour
This commit is contained in:
Thaddeus Crews 2025-01-27 09:46:08 -06:00
commit 583b6aef9c
No known key found for this signature in database
GPG key ID: 62181B86FE9E5D84

View file

@ -6,6 +6,7 @@
<description>
[SubViewport] Isolates a rectangular region of a scene to be displayed independently. This can be used, for example, to display UI in 3D space.
[b]Note:[/b] [SubViewport] is a [Viewport] that isn't a [Window], i.e. it doesn't draw anything by itself. To display anything, [SubViewport] must have a non-zero size and be either put inside a [SubViewportContainer] or assigned to a [ViewportTexture].
[b]Note:[/b] [InputEvent]s are not passed to a standalone [SubViewport] by default. To ensure [InputEvent] propagation, a [SubViewport] can be placed inside of a [SubViewportContainer].
</description>
<tutorials>
<link title="Using Viewports">$DOCS_URL/tutorials/rendering/viewports.html</link>