diff options
| author | VolTer <mew.pur.pur@abv.bg> | 2023-04-30 16:26:09 +0200 |
|---|---|---|
| committer | VolTer <mew.pur.pur@abv.bg> | 2023-05-28 14:24:54 +0200 |
| commit | 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79 (patch) | |
| tree | e5d78c825e09d7718156870377155dbc2331518a /doc/classes/SubViewport.xml | |
| parent | a67d37f7cffe7f31c68e971280950d487ea99e2c (diff) | |
| download | redot-engine-151a4ba6a59f6e965bb56ce8fbc75b14d056fa79.tar.gz | |
Overhaul the top sections of the class reference (GUI classes)
Diffstat (limited to 'doc/classes/SubViewport.xml')
| -rw-r--r-- | doc/classes/SubViewport.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/SubViewport.xml b/doc/classes/SubViewport.xml index d90290da73..b6fded5621 100644 --- a/doc/classes/SubViewport.xml +++ b/doc/classes/SubViewport.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="SubViewport" inherits="Viewport" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - Creates a sub-view into the screen. + An interface to a game world that doesn't create a window or draw to the screen directly. </brief_description> <description> - [SubViewport] is a [Viewport] that isn't a [Window], i.e. it doesn't draw anything by itself. To display something, [SubViewport]'s [member size] must be non-zero and it should be either put inside a [SubViewportContainer] or assigned to a [ViewportTexture]. + [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]. </description> <tutorials> <link title="Using Viewports">$DOCS_URL/tutorials/rendering/viewports.html</link> |