Inicio Explorar Axuda
Iniciar sesión
Godot
/
godot-docs
réplica de https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Ficheiros Incidencias 0 Wiki
Árbore: 30bc58bbda
Ramas Etiquetas
godot-docs
/
classes
/
class_viewport.rst

class_viewport.rst 48 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_Viewport:
    5. 

  5. 

  6. Viewport
    7. 

  7. ========
    8. 

  8. 

  9. **Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. Creates a sub-view into the screen.
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | :ref:`World<class_world>`                      | :ref:`find_world<class_Viewport_find_world>`  **(** **)** const                                                                                                                                                     |
    23. 

  23. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`World2D<class_world2d>`                  | :ref:`find_world_2d<class_Viewport_find_world_2d>`  **(** **)** const                                                                                                                                               |
    25. 

  25. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`Camera<class_camera>`                    | :ref:`get_camera<class_Viewport_get_camera>`  **(** **)** const                                                                                                                                                     |
    27. 

  27. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`Transform2D<class_transform2d>`          | :ref:`get_canvas_transform<class_Viewport_get_canvas_transform>`  **(** **)** const                                                                                                                                 |
    29. 

  29. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`int<class_int>`                          | :ref:`get_clear_mode<class_Viewport_get_clear_mode>`  **(** **)** const                                                                                                                                             |
    31. 

  31. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`int<class_int>`                          | :ref:`get_debug_draw<class_Viewport_get_debug_draw>`  **(** **)** const                                                                                                                                             |
    33. 

  33. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`Transform2D<class_transform2d>`          | :ref:`get_final_transform<class_Viewport_get_final_transform>`  **(** **)** const                                                                                                                                   |
    35. 

  35. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`Transform2D<class_transform2d>`          | :ref:`get_global_canvas_transform<class_Viewport_get_global_canvas_transform>`  **(** **)** const                                                                                                                   |
    37. 

  37. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`bool<class_bool>`                        | :ref:`get_hdr<class_Viewport_get_hdr>`  **(** **)** const                                                                                                                                                           |
    39. 

  39. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`Vector2<class_vector2>`                  | :ref:`get_mouse_position<class_Viewport_get_mouse_position>`  **(** **)** const                                                                                                                                     |
    41. 

  41. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`int<class_int>`                          | :ref:`get_msaa<class_Viewport_get_msaa>`  **(** **)** const                                                                                                                                                         |
    43. 

  43. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`bool<class_bool>`                        | :ref:`get_physics_object_picking<class_Viewport_get_physics_object_picking>`  **(** **)**                                                                                                                           |
    45. 

  45. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`int<class_int>`                          | :ref:`get_render_info<class_Viewport_get_render_info>`  **(** :ref:`int<class_int>` info  **)**                                                                                                                     |
    47. 

  47. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`int<class_int>`                          | :ref:`get_shadow_atlas_quadrant_subdiv<class_Viewport_get_shadow_atlas_quadrant_subdiv>`  **(** :ref:`int<class_int>` quadrant  **)** const                                                                         |
    49. 

  49. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`int<class_int>`                          | :ref:`get_shadow_atlas_size<class_Viewport_get_shadow_atlas_size>`  **(** **)** const                                                                                                                               |
    51. 

  51. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`Vector2<class_vector2>`                  | :ref:`get_size<class_Viewport_get_size>`  **(** **)** const                                                                                                                                                         |
    53. 

  53. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`Vector2<class_vector2>`                  | :ref:`get_size_override<class_Viewport_get_size_override>`  **(** **)** const                                                                                                                                       |
    55. 

  55. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | :ref:`ViewportTexture<class_viewporttexture>`  | :ref:`get_texture<class_Viewport_get_texture>`  **(** **)** const                                                                                                                                                   |
    57. 

  57. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | :ref:`int<class_int>`                          | :ref:`get_update_mode<class_Viewport_get_update_mode>`  **(** **)** const                                                                                                                                           |
    59. 

  59. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | :ref:`int<class_int>`                          | :ref:`get_usage<class_Viewport_get_usage>`  **(** **)** const                                                                                                                                                       |
    61. 

  61. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | :ref:`bool<class_bool>`                        | :ref:`get_vflip<class_Viewport_get_vflip>`  **(** **)** const                                                                                                                                                       |
    63. 

  63. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | :ref:`RID<class_rid>`                          | :ref:`get_viewport_rid<class_Viewport_get_viewport_rid>`  **(** **)** const                                                                                                                                         |
    65. 

  65. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`Rect2<class_rect2>`                      | :ref:`get_visible_rect<class_Viewport_get_visible_rect>`  **(** **)** const                                                                                                                                         |
    67. 

  67. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | :ref:`World<class_world>`                      | :ref:`get_world<class_Viewport_get_world>`  **(** **)** const                                                                                                                                                       |
    69. 

  69. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | :ref:`World2D<class_world2d>`                  | :ref:`get_world_2d<class_Viewport_get_world_2d>`  **(** **)** const                                                                                                                                                 |
    71. 

  71. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | :ref:`Variant<class_variant>`                  | :ref:`gui_get_drag_data<class_Viewport_gui_get_drag_data>`  **(** **)** const                                                                                                                                       |
    73. 

  73. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | :ref:`bool<class_bool>`                        | :ref:`gui_has_modal_stack<class_Viewport_gui_has_modal_stack>`  **(** **)** const                                                                                                                                   |
    75. 

  75. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | :ref:`bool<class_bool>`                        | :ref:`has_transparent_background<class_Viewport_has_transparent_background>`  **(** **)** const                                                                                                                     |
    77. 

  77. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | void                                           | :ref:`input<class_Viewport_input>`  **(** :ref:`InputEvent<class_inputevent>` local_event  **)**                                                                                                                    |
    79. 

  79. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | :ref:`bool<class_bool>`                        | :ref:`is_3d_disabled<class_Viewport_is_3d_disabled>`  **(** **)** const                                                                                                                                             |
    81. 

  81. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    82. 

  82. | :ref:`bool<class_bool>`                        | :ref:`is_audio_listener<class_Viewport_is_audio_listener>`  **(** **)** const                                                                                                                                       |
    83. 

  83. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    84. 

  84. | :ref:`bool<class_bool>`                        | :ref:`is_audio_listener_2d<class_Viewport_is_audio_listener_2d>`  **(** **)** const                                                                                                                                 |
    85. 

  85. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    86. 

  86. | :ref:`bool<class_bool>`                        | :ref:`is_input_disabled<class_Viewport_is_input_disabled>`  **(** **)** const                                                                                                                                       |
    87. 

  87. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    88. 

  88. | :ref:`bool<class_bool>`                        | :ref:`is_size_override_enabled<class_Viewport_is_size_override_enabled>`  **(** **)** const                                                                                                                         |
    89. 

  89. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    90. 

  90. | :ref:`bool<class_bool>`                        | :ref:`is_size_override_stretch_enabled<class_Viewport_is_size_override_stretch_enabled>`  **(** **)** const                                                                                                         |
    91. 

  91. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    92. 

  92. | :ref:`bool<class_bool>`                        | :ref:`is_using_own_world<class_Viewport_is_using_own_world>`  **(** **)** const                                                                                                                                     |
    93. 

  93. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94. | void                                           | :ref:`set_as_audio_listener<class_Viewport_set_as_audio_listener>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                     |
    95. 

  95. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    96. 

  96. | void                                           | :ref:`set_as_audio_listener_2d<class_Viewport_set_as_audio_listener_2d>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                               |
    97. 

  97. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    98. 

  98. | void                                           | :ref:`set_attach_to_screen_rect<class_Viewport_set_attach_to_screen_rect>`  **(** :ref:`Rect2<class_rect2>` rect  **)**                                                                                             |
    99. 

  99. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    100. 

  100. | void                                           | :ref:`set_canvas_transform<class_Viewport_set_canvas_transform>`  **(** :ref:`Transform2D<class_transform2d>` xform  **)**                                                                                          |
    101. 

  101. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    102. 

  102. | void                                           | :ref:`set_clear_mode<class_Viewport_set_clear_mode>`  **(** :ref:`int<class_int>` mode  **)**                                                                                                                       |
    103. 

  103. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    104. 

  104. | void                                           | :ref:`set_debug_draw<class_Viewport_set_debug_draw>`  **(** :ref:`int<class_int>` debug_draw  **)**                                                                                                                 |
    105. 

  105. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    106. 

  106. | void                                           | :ref:`set_disable_3d<class_Viewport_set_disable_3d>`  **(** :ref:`bool<class_bool>` disable  **)**                                                                                                                  |
    107. 

  107. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    108. 

  108. | void                                           | :ref:`set_disable_input<class_Viewport_set_disable_input>`  **(** :ref:`bool<class_bool>` disable  **)**                                                                                                            |
    109. 

  109. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    110. 

  110. | void                                           | :ref:`set_global_canvas_transform<class_Viewport_set_global_canvas_transform>`  **(** :ref:`Transform2D<class_transform2d>` xform  **)**                                                                            |
    111. 

  111. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    112. 

  112. | void                                           | :ref:`set_hdr<class_Viewport_set_hdr>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                                 |
    113. 

  113. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    114. 

  114. | void                                           | :ref:`set_msaa<class_Viewport_set_msaa>`  **(** :ref:`int<class_int>` msaa  **)**                                                                                                                                   |
    115. 

  115. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    116. 

  116. | void                                           | :ref:`set_physics_object_picking<class_Viewport_set_physics_object_picking>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                           |
    117. 

  117. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    118. 

  118. | void                                           | :ref:`set_shadow_atlas_quadrant_subdiv<class_Viewport_set_shadow_atlas_quadrant_subdiv>`  **(** :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdiv  **)**                                                 |
    119. 

  119. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    120. 

  120. | void                                           | :ref:`set_shadow_atlas_size<class_Viewport_set_shadow_atlas_size>`  **(** :ref:`int<class_int>` size  **)**                                                                                                         |
    121. 

  121. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    122. 

  122. | void                                           | :ref:`set_size<class_Viewport_set_size>`  **(** :ref:`Vector2<class_vector2>` size  **)**                                                                                                                           |
    123. 

  123. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    124. 

  124. | void                                           | :ref:`set_size_override<class_Viewport_set_size_override>`  **(** :ref:`bool<class_bool>` enable, :ref:`Vector2<class_vector2>` size=Vector2( -1, -1 ), :ref:`Vector2<class_vector2>` margin=Vector2( 0, 0 )  **)** |
    125. 

  125. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    126. 

  126. | void                                           | :ref:`set_size_override_stretch<class_Viewport_set_size_override_stretch>`  **(** :ref:`bool<class_bool>` enabled  **)**                                                                                            |
    127. 

  127. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    128. 

  128. | void                                           | :ref:`set_transparent_background<class_Viewport_set_transparent_background>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                           |
    129. 

  129. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    130. 

  130. | void                                           | :ref:`set_update_mode<class_Viewport_set_update_mode>`  **(** :ref:`int<class_int>` mode  **)**                                                                                                                     |
    131. 

  131. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    132. 

  132. | void                                           | :ref:`set_usage<class_Viewport_set_usage>`  **(** :ref:`int<class_int>` usage  **)**                                                                                                                                |
    133. 

  133. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    134. 

  134. | void                                           | :ref:`set_use_arvr<class_Viewport_set_use_arvr>`  **(** :ref:`bool<class_bool>` use  **)**                                                                                                                          |
    135. 

  135. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    136. 

  136. | void                                           | :ref:`set_use_own_world<class_Viewport_set_use_own_world>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                             |
    137. 

  137. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    138. 

  138. | void                                           | :ref:`set_vflip<class_Viewport_set_vflip>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                             |
    139. 

  139. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    140. 

  140. | void                                           | :ref:`set_world<class_Viewport_set_world>`  **(** :ref:`World<class_world>` world  **)**                                                                                                                            |
    141. 

  141. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    142. 

  142. | void                                           | :ref:`set_world_2d<class_Viewport_set_world_2d>`  **(** :ref:`World2D<class_world2d>` world_2d  **)**                                                                                                               |
    143. 

  143. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    144. 

  144. | void                                           | :ref:`unhandled_input<class_Viewport_unhandled_input>`  **(** :ref:`InputEvent<class_inputevent>` local_event  **)**                                                                                                |
    145. 

  145. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    146. 

  146. | void                                           | :ref:`update_worlds<class_Viewport_update_worlds>`  **(** **)**                                                                                                                                                     |
    147. 

  147. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    148. 

  148. | :ref:`bool<class_bool>`                        | :ref:`use_arvr<class_Viewport_use_arvr>`  **(** **)**                                                                                                                                                               |
    149. 

  149. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    150. 

  150. | void                                           | :ref:`warp_mouse<class_Viewport_warp_mouse>`  **(** :ref:`Vector2<class_vector2>` to_pos  **)**                                                                                                                     |
    151. 

  151. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    152. 

  152. 

  153. Signals
    154. 

  154. -------
    155. 

  155. 

  156. -  **size_changed**  **(** **)**
    157. 

  157. Emitted when the size of the viewport is changed, whether by :ref:`set_size_override<class_Viewport_set_size_override>`, resize of window, or some other means.
    158. 

  158. 

  159. 

  160. Member Variables
    161. 

  161. ----------------
    162. 

  162. 

  163. - :ref:`bool<class_bool>` **arvr**
    164. 

  164. - :ref:`bool<class_bool>` **audio_listener_enable_2d**
    165. 

  165. - :ref:`bool<class_bool>` **audio_listener_enable_3d**
    166. 

  166. - :ref:`int<class_int>` **debug_draw**
    167. 

  167. - :ref:`bool<class_bool>` **disable_3d**
    168. 

  168. - :ref:`bool<class_bool>` **gui_disable_input**
    169. 

  169. - :ref:`bool<class_bool>` **hdr**
    170. 

  170. - :ref:`int<class_int>` **msaa**
    171. 

  171. - :ref:`bool<class_bool>` **own_world**
    172. 

  172. - :ref:`bool<class_bool>` **physics_object_picking**
    173. 

  173. - :ref:`int<class_int>` **render_target_clear_mode**
    174. 

  174. - :ref:`int<class_int>` **render_target_update_mode**
    175. 

  175. - :ref:`bool<class_bool>` **render_target_v_flip**
    176. 

  176. - :ref:`int<class_int>` **shadow_atlas_quad_0**
    177. 

  177. - :ref:`int<class_int>` **shadow_atlas_quad_1**
    178. 

  178. - :ref:`int<class_int>` **shadow_atlas_quad_2**
    179. 

  179. - :ref:`int<class_int>` **shadow_atlas_quad_3**
    180. 

  180. - :ref:`int<class_int>` **shadow_atlas_size**
    181. 

  181. - :ref:`Vector2<class_vector2>` **size**
    182. 

  182. - :ref:`bool<class_bool>` **transparent_bg**
    183. 

  183. - :ref:`int<class_int>` **usage**
    184. 

  184. - :ref:`World<class_world>` **world**
    185. 

  185. 

  186. Numeric Constants
    187. 

  187. -----------------
    188. 

  188. 

  189. - **UPDATE_DISABLED** = **0** --- Do not update the render target.
    190. 

  190. - **UPDATE_ONCE** = **1** --- Update the render target once, then switch to ``UPDATE_DISABLED``
    191. 

  191. - **UPDATE_WHEN_VISIBLE** = **2** --- Update the render target only when it is visible. This is the default value.
    192. 

  192. - **UPDATE_ALWAYS** = **3**
    193. 

  193. - **SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED** = **0**
    194. 

  194. - **SHADOW_ATLAS_QUADRANT_SUBDIV_1** = **1**
    195. 

  195. - **SHADOW_ATLAS_QUADRANT_SUBDIV_4** = **2**
    196. 

  196. - **SHADOW_ATLAS_QUADRANT_SUBDIV_16** = **3**
    197. 

  197. - **SHADOW_ATLAS_QUADRANT_SUBDIV_64** = **4**
    198. 

  198. - **SHADOW_ATLAS_QUADRANT_SUBDIV_256** = **5**
    199. 

  199. - **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = **6**
    200. 

  200. - **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7**
    201. 

  201. - **RENDER_INFO_OBJECTS_IN_FRAME** = **0**
    202. 

  202. - **RENDER_INFO_VERTICES_IN_FRAME** = **1**
    203. 

  203. - **RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2**
    204. 

  204. - **RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3**
    205. 

  205. - **RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4**
    206. 

  206. - **RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5**
    207. 

  207. - **RENDER_INFO_MAX** = **6**
    208. 

  208. - **DEBUG_DRAW_DISABLED** = **0**
    209. 

  209. - **DEBUG_DRAW_UNSHADED** = **1**
    210. 

  210. - **DEBUG_DRAW_OVERDRAW** = **2**
    211. 

  211. - **DEBUG_DRAW_WIREFRAME** = **3**
    212. 

  212. - **MSAA_DISABLED** = **0**
    213. 

  213. - **MSAA_2X** = **1**
    214. 

  214. - **MSAA_4X** = **2**
    215. 

  215. - **MSAA_8X** = **3**
    216. 

  216. - **MSAA_16X** = **4**
    217. 

  217. 

  218. Description
    219. 

  219. -----------
    220. 

  220. 

  221. 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.
    222. 

  222. 

  223. Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports.
    224. 

  224. 

  225. If a viewport is a child of a :ref:`Control<class_control>`, it will automatically take up its same rect and position, otherwise they must be set manually.
    226. 

  226. 

  227. Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it.
    228. 

  228. 

  229. Also, viewports can be assigned to different screens in case the devices have multiple screens.
    230. 

  230. 

  231. Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw.
    232. 

  232. 

  233. Member Function Description
    234. 

  234. ---------------------------
    235. 

  235. 

  236. .. _class_Viewport_find_world:
    237. 

  237. 

  238. - :ref:`World<class_world>`  **find_world**  **(** **)** const
    239. 

  239. 

  240. Return the 3D world of the viewport, or if no such present, the one of the parent viewport.
    241. 

  241. 

  242. .. _class_Viewport_find_world_2d:
    243. 

  243. 

  244. - :ref:`World2D<class_world2d>`  **find_world_2d**  **(** **)** const
    245. 

  245. 

  246. Return the 2D world of the viewport.
    247. 

  247. 

  248. .. _class_Viewport_get_camera:
    249. 

  249. 

  250. - :ref:`Camera<class_camera>`  **get_camera**  **(** **)** const
    251. 

  251. 

  252. Return the active 3D camera.
    253. 

  253. 

  254. .. _class_Viewport_get_canvas_transform:
    255. 

  255. 

  256. - :ref:`Transform2D<class_transform2d>`  **get_canvas_transform**  **(** **)** const
    257. 

  257. 

  258. Get the canvas transform of the viewport.
    259. 

  259. 

  260. .. _class_Viewport_get_clear_mode:
    261. 

  261. 

  262. - :ref:`int<class_int>`  **get_clear_mode**  **(** **)** const
    263. 

  263. 

  264. .. _class_Viewport_get_debug_draw:
    265. 

  265. 

  266. - :ref:`int<class_int>`  **get_debug_draw**  **(** **)** const
    267. 

  267. 

  268. .. _class_Viewport_get_final_transform:
    269. 

  269. 

  270. - :ref:`Transform2D<class_transform2d>`  **get_final_transform**  **(** **)** const
    271. 

  271. 

  272. Get the total transform of the viewport.
    273. 

  273. 

  274. .. _class_Viewport_get_global_canvas_transform:
    275. 

  275. 

  276. - :ref:`Transform2D<class_transform2d>`  **get_global_canvas_transform**  **(** **)** const
    277. 

  277. 

  278. Get the global canvas transform of the viewport.
    279. 

  279. 

  280. .. _class_Viewport_get_hdr:
    281. 

  281. 

  282. - :ref:`bool<class_bool>`  **get_hdr**  **(** **)** const
    283. 

  283. 

  284. Get whether the rendered texture has filters enabled.
    285. 

  285. 

  286. .. _class_Viewport_get_mouse_position:
    287. 

  287. 

  288. - :ref:`Vector2<class_vector2>`  **get_mouse_position**  **(** **)** const
    289. 

  289. 

  290. Get the mouse position, relative to the viewport.
    291. 

  291. 

  292. .. _class_Viewport_get_msaa:
    293. 

  293. 

  294. - :ref:`int<class_int>`  **get_msaa**  **(** **)** const
    295. 

  295. 

  296. .. _class_Viewport_get_physics_object_picking:
    297. 

  297. 

  298. - :ref:`bool<class_bool>`  **get_physics_object_picking**  **(** **)**
    299. 

  299. 

  300. Get whether picking for all physics objects inside the viewport is enabled.
    301. 

  301. 

  302. .. _class_Viewport_get_render_info:
    303. 

  303. 

  304. - :ref:`int<class_int>`  **get_render_info**  **(** :ref:`int<class_int>` info  **)**
    305. 

  305. 

  306. .. _class_Viewport_get_shadow_atlas_quadrant_subdiv:
    307. 

  307. 

  308. - :ref:`int<class_int>`  **get_shadow_atlas_quadrant_subdiv**  **(** :ref:`int<class_int>` quadrant  **)** const
    309. 

  309. 

  310. .. _class_Viewport_get_shadow_atlas_size:
    311. 

  311. 

  312. - :ref:`int<class_int>`  **get_shadow_atlas_size**  **(** **)** const
    313. 

  313. 

  314. .. _class_Viewport_get_size:
    315. 

  315. 

  316. - :ref:`Vector2<class_vector2>`  **get_size**  **(** **)** const
    317. 

  317. 

  318. Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space.
    319. 

  319. 

  320. .. _class_Viewport_get_size_override:
    321. 

  321. 

  322. - :ref:`Vector2<class_vector2>`  **get_size_override**  **(** **)** const
    323. 

  323. 

  324. Get the size override set with :ref:`set_size_override<class_Viewport_set_size_override>`.
    325. 

  325. 

  326. .. _class_Viewport_get_texture:
    327. 

  327. 

  328. - :ref:`ViewportTexture<class_viewporttexture>`  **get_texture**  **(** **)** const
    329. 

  329. 

  330. Get the viewport's texture, for use with various objects that you want to texture with the viewport.
    331. 

  331. 

  332. .. _class_Viewport_get_update_mode:
    333. 

  333. 

  334. - :ref:`int<class_int>`  **get_update_mode**  **(** **)** const
    335. 

  335. 

  336. Get when the viewport would be updated, will be one of the ``UPDATE\_\*`` constants.
    337. 

  337. 

  338. .. _class_Viewport_get_usage:
    339. 

  339. 

  340. - :ref:`int<class_int>`  **get_usage**  **(** **)** const
    341. 

  341. 

  342. .. _class_Viewport_get_vflip:
    343. 

  343. 

  344. - :ref:`bool<class_bool>`  **get_vflip**  **(** **)** const
    345. 

  345. 

  346. Set whether the render target is flipped on the Y axis.
    347. 

  347. 

  348. .. _class_Viewport_get_viewport_rid:
    349. 

  349. 

  350. - :ref:`RID<class_rid>`  **get_viewport_rid**  **(** **)** const
    351. 

  351. 

  352. Get the viewport RID from the :ref:`VisualServer<class_visualserver>`.
    353. 

  353. 

  354. .. _class_Viewport_get_visible_rect:
    355. 

  355. 

  356. - :ref:`Rect2<class_rect2>`  **get_visible_rect**  **(** **)** const
    357. 

  357. 

  358. Return the final, visible rect in global screen coordinates.
    359. 

  359. 

  360. .. _class_Viewport_get_world:
    361. 

  361. 

  362. - :ref:`World<class_world>`  **get_world**  **(** **)** const
    363. 

  363. 

  364. Return the 3D world of the viewport.
    365. 

  365. 

  366. .. _class_Viewport_get_world_2d:
    367. 

  367. 

  368. - :ref:`World2D<class_world2d>`  **get_world_2d**  **(** **)** const
    369. 

  369. 

  370. Return the 2D world of the viewport.
    371. 

  371. 

  372. .. _class_Viewport_gui_get_drag_data:
    373. 

  373. 

  374. - :ref:`Variant<class_variant>`  **gui_get_drag_data**  **(** **)** const
    375. 

  375. 

  376. Returs the drag data from the GUI, that was previously returned by :ref:`Control.get_drag_data<class_Control_get_drag_data>`.
    377. 

  377. 

  378. .. _class_Viewport_gui_has_modal_stack:
    379. 

  379. 

  380. - :ref:`bool<class_bool>`  **gui_has_modal_stack**  **(** **)** const
    381. 

  381. 

  382. Returs whether there are shown modals on-screen.
    383. 

  383. 

  384. .. _class_Viewport_has_transparent_background:
    385. 

  385. 

  386. - :ref:`bool<class_bool>`  **has_transparent_background**  **(** **)** const
    387. 

  387. 

  388. Return whether the viewport lets whatever is behind it to show.
    389. 

  389. 

  390. .. _class_Viewport_input:
    391. 

  391. 

  392. - void  **input**  **(** :ref:`InputEvent<class_inputevent>` local_event  **)**
    393. 

  393. 

  394. .. _class_Viewport_is_3d_disabled:
    395. 

  395. 

  396. - :ref:`bool<class_bool>`  **is_3d_disabled**  **(** **)** const
    397. 

  397. 

  398. .. _class_Viewport_is_audio_listener:
    399. 

  399. 

  400. - :ref:`bool<class_bool>`  **is_audio_listener**  **(** **)** const
    401. 

  401. 

  402. Returns whether the viewport sends sounds to the speakers.
    403. 

  403. 

  404. .. _class_Viewport_is_audio_listener_2d:
    405. 

  405. 

  406. - :ref:`bool<class_bool>`  **is_audio_listener_2d**  **(** **)** const
    407. 

  407. 

  408. Returns whether the viewport sends soundsfrom 2D emitters to the speakers.
    409. 

  409. 

  410. .. _class_Viewport_is_input_disabled:
    411. 

  411. 

  412. - :ref:`bool<class_bool>`  **is_input_disabled**  **(** **)** const
    413. 

  413. 

  414. Return whether input to the viewport is disabled.
    415. 

  415. 

  416. .. _class_Viewport_is_size_override_enabled:
    417. 

  417. 

  418. - :ref:`bool<class_bool>`  **is_size_override_enabled**  **(** **)** const
    419. 

  419. 

  420. Get the enabled status of the size override set with :ref:`set_size_override<class_Viewport_set_size_override>`.
    421. 

  421. 

  422. .. _class_Viewport_is_size_override_stretch_enabled:
    423. 

  423. 

  424. - :ref:`bool<class_bool>`  **is_size_override_stretch_enabled**  **(** **)** const
    425. 

  425. 

  426. Get the enabled status of the size strech override set with :ref:`set_size_override_stretch<class_Viewport_set_size_override_stretch>`.
    427. 

  427. 

  428. .. _class_Viewport_is_using_own_world:
    429. 

  429. 

  430. - :ref:`bool<class_bool>`  **is_using_own_world**  **(** **)** const
    431. 

  431. 

  432. Return whether the viewport is using a world separate from the parent viewport's world.
    433. 

  433. 

  434. .. _class_Viewport_set_as_audio_listener:
    435. 

  435. 

  436. - void  **set_as_audio_listener**  **(** :ref:`bool<class_bool>` enable  **)**
    437. 

  437. 

  438. Makes the viewport send sounds to the speakers.
    439. 

  439. 

  440. .. _class_Viewport_set_as_audio_listener_2d:
    441. 

  441. 

  442. - void  **set_as_audio_listener_2d**  **(** :ref:`bool<class_bool>` enable  **)**
    443. 

  443. 

  444. Makes the viewport send sounds from 2D emitters to the speakers.
    445. 

  445. 

  446. .. _class_Viewport_set_attach_to_screen_rect:
    447. 

  447. 

  448. - void  **set_attach_to_screen_rect**  **(** :ref:`Rect2<class_rect2>` rect  **)**
    449. 

  449. 

  450. .. _class_Viewport_set_canvas_transform:
    451. 

  451. 

  452. - void  **set_canvas_transform**  **(** :ref:`Transform2D<class_transform2d>` xform  **)**
    453. 

  453. 

  454. Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem<class_canvasitem>`\ s. This is relative to the global canvas transform of the viewport.
    455. 

  455. 

  456. .. _class_Viewport_set_clear_mode:
    457. 

  457. 

  458. - void  **set_clear_mode**  **(** :ref:`int<class_int>` mode  **)**
    459. 

  459. 

  460. .. _class_Viewport_set_debug_draw:
    461. 

  461. 

  462. - void  **set_debug_draw**  **(** :ref:`int<class_int>` debug_draw  **)**
    463. 

  463. 

  464. .. _class_Viewport_set_disable_3d:
    465. 

  465. 

  466. - void  **set_disable_3d**  **(** :ref:`bool<class_bool>` disable  **)**
    467. 

  467. 

  468. .. _class_Viewport_set_disable_input:
    469. 

  469. 

  470. - void  **set_disable_input**  **(** :ref:`bool<class_bool>` disable  **)**
    471. 

  471. 

  472. Set whether input to the viewport is disabled.
    473. 

  473. 

  474. .. _class_Viewport_set_global_canvas_transform:
    475. 

  475. 

  476. - void  **set_global_canvas_transform**  **(** :ref:`Transform2D<class_transform2d>` xform  **)**
    477. 

  477. 

  478. Set the global canvas transform of the viewport. The canvas transform is relative to this.
    479. 

  479. 

  480. .. _class_Viewport_set_hdr:
    481. 

  481. 

  482. - void  **set_hdr**  **(** :ref:`bool<class_bool>` enable  **)**
    483. 

  483. 

  484. .. _class_Viewport_set_msaa:
    485. 

  485. 

  486. - void  **set_msaa**  **(** :ref:`int<class_int>` msaa  **)**
    487. 

  487. 

  488. .. _class_Viewport_set_physics_object_picking:
    489. 

  489. 

  490. - void  **set_physics_object_picking**  **(** :ref:`bool<class_bool>` enable  **)**
    491. 

  491. 

  492. Enable/disable picking for all physics objects inside the viewport.
    493. 

  493. 

  494. .. _class_Viewport_set_shadow_atlas_quadrant_subdiv:
    495. 

  495. 

  496. - void  **set_shadow_atlas_quadrant_subdiv**  **(** :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdiv  **)**
    497. 

  497. 

  498. .. _class_Viewport_set_shadow_atlas_size:
    499. 

  499. 

  500. - void  **set_shadow_atlas_size**  **(** :ref:`int<class_int>` size  **)**
    501. 

  501. 

  502. .. _class_Viewport_set_size:
    503. 

  503. 

  504. - void  **set_size**  **(** :ref:`Vector2<class_vector2>` size  **)**
    505. 

  505. 

  506. Set the size of the viewport.
    507. 

  507. 

  508. .. _class_Viewport_set_size_override:
    509. 

  509. 

  510. - void  **set_size_override**  **(** :ref:`bool<class_bool>` enable, :ref:`Vector2<class_vector2>` size=Vector2( -1, -1 ), :ref:`Vector2<class_vector2>` margin=Vector2( 0, 0 )  **)**
    511. 

  511. 

  512. 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 ``(-1, -1)``, it won't update the size.
    513. 

  513. 

  514. .. _class_Viewport_set_size_override_stretch:
    515. 

  515. 

  516. - void  **set_size_override_stretch**  **(** :ref:`bool<class_bool>` enabled  **)**
    517. 

  517. 

  518. Set whether the size override affects stretch as well.
    519. 

  519. 

  520. .. _class_Viewport_set_transparent_background:
    521. 

  521. 

  522. - void  **set_transparent_background**  **(** :ref:`bool<class_bool>` enable  **)**
    523. 

  523. 

  524. If this viewport is a child of another viewport, keep the previously drawn background visible.
    525. 

  525. 

  526. .. _class_Viewport_set_update_mode:
    527. 

  527. 

  528. - void  **set_update_mode**  **(** :ref:`int<class_int>` mode  **)**
    529. 

  529. 

  530. Set when the render target would be updated, using the ``UPDATE\_\*`` constants
    531. 

  531. 

  532. .. _class_Viewport_set_usage:
    533. 

  533. 

  534. - void  **set_usage**  **(** :ref:`int<class_int>` usage  **)**
    535. 

  535. 

  536. .. _class_Viewport_set_use_arvr:
    537. 

  537. 

  538. - void  **set_use_arvr**  **(** :ref:`bool<class_bool>` use  **)**
    539. 

  539. 

  540. .. _class_Viewport_set_use_own_world:
    541. 

  541. 

  542. - void  **set_use_own_world**  **(** :ref:`bool<class_bool>` enable  **)**
    543. 

  543. 

  544. Make the viewport use a world separate from the parent viewport's world.
    545. 

  545. 

  546. .. _class_Viewport_set_vflip:
    547. 

  547. 

  548. - void  **set_vflip**  **(** :ref:`bool<class_bool>` enable  **)**
    549. 

  549. 

  550. Set whether the viewport is flipped on the Y axis.
    551. 

  551. 

  552. .. _class_Viewport_set_world:
    553. 

  553. 

  554. - void  **set_world**  **(** :ref:`World<class_world>` world  **)**
    555. 

  555. 

  556. Change the 3D world of the viewport.
    557. 

  557. 

  558. .. _class_Viewport_set_world_2d:
    559. 

  559. 

  560. - void  **set_world_2d**  **(** :ref:`World2D<class_world2d>` world_2d  **)**
    561. 

  561. 

  562. .. _class_Viewport_unhandled_input:
    563. 

  563. 

  564. - void  **unhandled_input**  **(** :ref:`InputEvent<class_inputevent>` local_event  **)**
    565. 

  565. 

  566. .. _class_Viewport_update_worlds:
    567. 

  567. 

  568. - void  **update_worlds**  **(** **)**
    569. 

  569. 

  570. Force update of the 2D and 3D worlds.
    571. 

  571. 

  572. .. _class_Viewport_use_arvr:
    573. 

  573. 

  574. - :ref:`bool<class_bool>`  **use_arvr**  **(** **)**
    575. 

  575. 

  576. .. _class_Viewport_warp_mouse:
    577. 

  577. 

  578. - void  **warp_mouse**  **(** :ref:`Vector2<class_vector2>` to_pos  **)**
    579. 

  579. 

  580. Warp the mouse to a position, relative to the viewport.
    581. 

  581. 

  582.