godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated Viewport docs to correct wrong information and fill out empty sections 

(cherry picked from commit 650ebdc832)
This commit is contained in:
clayjohn 2018-06-10 11:40:25 -07:00 committed by Rémi Verschelde
parent f49fcc960b
commit 394838901d
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/classes/Viewport.xml
View File

@ -6,7 +6,7 @@
<description> <description>
A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too. A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too.
Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports. Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports.
If a viewport is a child of a [Control], it will automatically take up its same rect and position, otherwise they must be set manually. If a viewport is a child of a [ViewportContainer], it will automatically take up its size, otherwise it must be set manually.
Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it.
Also, viewports can be assigned to different screens in case the devices have multiple screens. Also, viewports can be assigned to different screens in case the devices have multiple screens.
Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw. Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw.
@ -273,7 +273,7 @@
Do not update the render target. Do not update the render target.
</constant> </constant>
<constant name="UPDATE_ONCE" value="1" enum="UpdateMode"> <constant name="UPDATE_ONCE" value="1" enum="UpdateMode">
Update the render target once, then switch to [code]UPDATE_DISABLED[/code] Update the render target once, then switch to [code]UPDATE_DISABLED[/code].
</constant> </constant>
<constant name="UPDATE_WHEN_VISIBLE" value="2" enum="UpdateMode"> <constant name="UPDATE_WHEN_VISIBLE" value="2" enum="UpdateMode">
Update the render target only when it is visible. This is the default value. Update the render target only when it is visible. This is the default value.
@ -326,6 +326,7 @@
Objects are displayed without light information. Objects are displayed without light information.
</constant> </constant>
<constant name="DEBUG_DRAW_OVERDRAW" value="2" enum="DebugDraw"> <constant name="DEBUG_DRAW_OVERDRAW" value="2" enum="DebugDraw">
Objected are displayed semi-transparent with additive blending so you can see where they intersect.
</constant> </constant>
<constant name="DEBUG_DRAW_WIREFRAME" value="3" enum="DebugDraw"> <constant name="DEBUG_DRAW_WIREFRAME" value="3" enum="DebugDraw">
Objects are displayed in wireframe style. Objects are displayed in wireframe style.
@ -350,10 +351,13 @@
<constant name="USAGE_3D_NO_EFFECTS" value="3" enum="Usage"> <constant name="USAGE_3D_NO_EFFECTS" value="3" enum="Usage">
</constant> </constant>
<constant name="CLEAR_MODE_ALWAYS" value="0" enum="ClearMode"> <constant name="CLEAR_MODE_ALWAYS" value="0" enum="ClearMode">
Always clear the render target before drawing.
</constant> </constant>
<constant name="CLEAR_MODE_NEVER" value="1" enum="ClearMode"> <constant name="CLEAR_MODE_NEVER" value="1" enum="ClearMode">
Never clear the render target.
</constant> </constant>
<constant name="CLEAR_MODE_ONLY_NEXT_FRAME" value="2" enum="ClearMode"> <constant name="CLEAR_MODE_ONLY_NEXT_FRAME" value="2" enum="ClearMode">
Clear the render target next frame, then switch to [code]CLEAR_MODE_NEVER[/code].
</constant> </constant>
</constants> </constants>
</class> </class>