1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Viewport" inherits="Node" category="Core" version="3.0-rc1">
<brief_description>
Creates a sub-view into the screen.
</brief_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.
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.
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.
Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw.
</description>
<tutorials>
http://docs.godotengine.org/en/3.0/learning/features/2d/2d_transforms.html
http://docs.godotengine.org/en/3.0/learning/features/viewports/index.html
</tutorials>
<demos>
</demos>
<methods>
<method name="find_world" qualifiers="const">
<return type="World">
</return>
<description>
Return the 3D world of the viewport, or if no such present, the one of the parent viewport.
</description>
</method>
<method name="find_world_2d" qualifiers="const">
<return type="World2D">
</return>
<description>
Return the 2D world of the viewport.
</description>
</method>
<method name="get_camera" qualifiers="const">
<return type="Camera">
</return>
<description>
Return the active 3D camera.
</description>
</method>
<method name="get_final_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Get the total transform of the viewport.
</description>
</method>
<method name="get_mouse_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
Get the mouse position, relative to the viewport.
</description>
</method>
<method name="get_render_info">
<return type="int">
</return>
<argument index="0" name="info" type="int" enum="Viewport.RenderInfo">
</argument>
<description>
</description>
</method>
<method name="get_size_override" qualifiers="const">
<return type="Vector2">
</return>
<description>
Get the size override set with [method set_size_override].
</description>
</method>
<method name="get_texture" qualifiers="const">
<return type="ViewportTexture">
</return>
<description>
Get the viewport's texture, for use with various objects that you want to texture with the viewport.
</description>
</method>
<method name="get_viewport_rid" qualifiers="const">
<return type="RID">
</return>
<description>
Get the viewport RID from the [VisualServer].
</description>
</method>
<method name="get_visible_rect" qualifiers="const">
<return type="Rect2">
</return>
<description>
Return the final, visible rect in global screen coordinates.
</description>
</method>
<method name="gui_get_drag_data" qualifiers="const">
<return type="Variant">
</return>
<description>
Returns the drag data from the GUI, that was previously returned by [method Control.get_drag_data].
</description>
</method>
<method name="gui_has_modal_stack" qualifiers="const">
<return type="bool">
</return>
<description>
Returns whether there are shown modals on-screen.
</description>
</method>
<method name="input">
<return type="void">
</return>
<argument index="0" name="local_event" type="InputEvent">
</argument>
<description>
</description>
</method>
<method name="is_size_override_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Get the enabled status of the size override set with [method set_size_override].
</description>
</method>
<method name="is_size_override_stretch_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Get the enabled status of the size strech override set with [method set_size_override_stretch].
</description>
</method>
<method name="set_attach_to_screen_rect">
<return type="void">
</return>
<argument index="0" name="rect" type="Rect2">
</argument>
<description>
</description>
</method>
<method name="set_size_override">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<argument index="1" name="size" type="Vector2" default="Vector2( -1, -1 )">
</argument>
<argument index="2" name="margin" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size.
</description>
</method>
<method name="set_size_override_stretch">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set whether the size override affects stretch as well.
</description>
</method>
<method name="unhandled_input">
<return type="void">
</return>
<argument index="0" name="local_event" type="InputEvent">
</argument>
<description>
</description>
</method>
<method name="update_worlds">
<return type="void">
</return>
<description>
Force update of the 2D and 3D worlds.
</description>
</method>
<method name="warp_mouse">
<return type="void">
</return>
<argument index="0" name="to_position" type="Vector2">
</argument>
<description>
Warp the mouse to a position, relative to the viewport.
</description>
</method>
</methods>
<members>
<member name="arvr" type="bool" setter="set_use_arvr" getter="use_arvr">
</member>
<member name="audio_listener_enable_2d" type="bool" setter="set_as_audio_listener_2d" getter="is_audio_listener_2d">
</member>
<member name="audio_listener_enable_3d" type="bool" setter="set_as_audio_listener" getter="is_audio_listener">
</member>
<member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform">
The canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport.
</member>
<member name="debug_draw" type="int" setter="set_debug_draw" getter="get_debug_draw" enum="Viewport.DebugDraw">
</member>
<member name="disable_3d" type="bool" setter="set_disable_3d" getter="is_3d_disabled">
</member>
<member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform">
The global canvas transform of the viewport. The canvas transform is relative to this.
</member>
<member name="gui_disable_input" type="bool" setter="set_disable_input" getter="is_input_disabled">
</member>
<member name="gui_snap_controls_to_pixels" type="bool" setter="set_snap_controls_to_pixels" getter="is_snap_controls_to_pixels_enabled">
</member>
<member name="hdr" type="bool" setter="set_hdr" getter="get_hdr">
</member>
<member name="msaa" type="int" setter="set_msaa" getter="get_msaa" enum="Viewport.MSAA">
</member>
<member name="own_world" type="bool" setter="set_use_own_world" getter="is_using_own_world">
</member>
<member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking">
</member>
<member name="render_target_clear_mode" type="int" setter="set_clear_mode" getter="get_clear_mode" enum="Viewport.ClearMode">
</member>
<member name="render_target_update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="Viewport.UpdateMode">
</member>
<member name="render_target_v_flip" type="bool" setter="set_vflip" getter="get_vflip">
</member>
<member name="shadow_atlas_quad_0" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv">
</member>
<member name="shadow_atlas_quad_1" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv">
</member>
<member name="shadow_atlas_quad_2" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv">
</member>
<member name="shadow_atlas_quad_3" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv">
</member>
<member name="shadow_atlas_size" type="int" setter="set_shadow_atlas_size" getter="get_shadow_atlas_size">
</member>
<member name="size" type="Vector2" setter="set_size" getter="get_size">
</member>
<member name="transparent_bg" type="bool" setter="set_transparent_background" getter="has_transparent_background">
</member>
<member name="usage" type="int" setter="set_usage" getter="get_usage" enum="Viewport.Usage">
</member>
<member name="world" type="World" setter="set_world" getter="get_world">
</member>
<member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d">
</member>
</members>
<signals>
<signal name="size_changed">
<description>
Emitted when the size of the viewport is changed, whether by [method set_size_override], resize of window, or some other means.
</description>
</signal>
</signals>
<constants>
<constant name="UPDATE_DISABLED" value="0" enum="UpdateMode">
Do not update the render target.
</constant>
<constant name="UPDATE_ONCE" value="1" enum="UpdateMode">
Update the render target once, then switch to [code]UPDATE_DISABLED[/code]
</constant>
<constant name="UPDATE_WHEN_VISIBLE" value="2" enum="UpdateMode">
Update the render target only when it is visible. This is the default value.
</constant>
<constant name="UPDATE_ALWAYS" value="3" enum="UpdateMode">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED" value="0" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1" value="1" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_4" value="2" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_16" value="3" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_64" value="4" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_256" value="5" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1024" value="6" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo">
</constant>
<constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo">
</constant>
<constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo">
</constant>
<constant name="RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="RenderInfo">
</constant>
<constant name="RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="RenderInfo">
</constant>
<constant name="RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="RenderInfo">
</constant>
<constant name="RENDER_INFO_MAX" value="6" enum="RenderInfo">
</constant>
<constant name="DEBUG_DRAW_DISABLED" value="0" enum="DebugDraw">
</constant>
<constant name="DEBUG_DRAW_UNSHADED" value="1" enum="DebugDraw">
</constant>
<constant name="DEBUG_DRAW_OVERDRAW" value="2" enum="DebugDraw">
</constant>
<constant name="DEBUG_DRAW_WIREFRAME" value="3" enum="DebugDraw">
</constant>
<constant name="MSAA_DISABLED" value="0" enum="MSAA">
</constant>
<constant name="MSAA_2X" value="1" enum="MSAA">
</constant>
<constant name="MSAA_4X" value="2" enum="MSAA">
</constant>
<constant name="MSAA_8X" value="3" enum="MSAA">
</constant>
<constant name="MSAA_16X" value="4" enum="MSAA">
</constant>
<constant name="USAGE_2D" value="0" enum="Usage">
</constant>
<constant name="USAGE_2D_NO_SAMPLING" value="1" enum="Usage">
</constant>
<constant name="USAGE_3D" value="2" enum="Usage">
</constant>
<constant name="USAGE_3D_NO_EFFECTS" value="3" enum="Usage">
</constant>
<constant name="CLEAR_MODE_ALWAYS" value="0" enum="ClearMode">
</constant>
<constant name="CLEAR_MODE_NEVER" value="1" enum="ClearMode">
</constant>
<constant name="CLEAR_MODE_ONLY_NEXT_FRAME" value="2" enum="ClearMode">
</constant>
</constants>
</class>
|