Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: ace47f729c
Branches Tags
godot-docs
/
classes
/
class_viewport.rst

class_viewport.rst 50 KB
History Raw

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

  2. .. DO NOT EDIT THIS FILE, but the Viewport.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_Viewport:
    6. 

  6. 

  7. Viewport
    8. 

  8. ========
    9. 

  9. 

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

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

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

  18. 

  19. Member Functions
    20. 

  20. ----------------
    21. 

  21. 

  22. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

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

  24. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

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

  26. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

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

  28. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

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

  30. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

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

  32. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

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

  34. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

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

  36. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

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

  38. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

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

  40. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

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

  42. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

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

  44. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

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

  46. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

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

  48. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

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

  50. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

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

  52. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

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

  54. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

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

  56. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

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

  58. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

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

  60. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

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

  62. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

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

  64. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    65. 

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

  66. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

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

  68. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    69. 

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

  70. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    71. 

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

  72. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    73. 

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

  74. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    75. 

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

  76. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    77. 

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

  78. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    79. 

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

  80. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    81. 

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

  82. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    83. 

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

  84. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    85. 

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

  86. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    87. 

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

  88. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    89. 

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

  90. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    91. 

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

  92. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    93. 

  93. | :ref:`bool<class_bool>`                        | :ref:`is_snap_controls_to_pixels_enabled<class_Viewport_is_snap_controls_to_pixels_enabled>`  **(** **)** const                                                                                                     |
    94. 

  94. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    95. 

  95. | :ref:`bool<class_bool>`                        | :ref:`is_using_own_world<class_Viewport_is_using_own_world>`  **(** **)** const                                                                                                                                     |
    96. 

  96. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    97. 

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

  98. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    99. 

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

  100. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    101. 

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

  102. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    103. 

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

  104. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    105. 

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

  106. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    107. 

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

  108. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    109. 

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

  110. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    111. 

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

  112. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    113. 

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

  114. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    115. 

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

  116. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    117. 

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

  118. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    119. 

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

  120. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    121. 

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

  122. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    123. 

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

  124. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    125. 

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

  126. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    127. 

  127. | 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 )  **)** |
    128. 

  128. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    129. 

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

  130. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    131. 

  131. | void                                           | :ref:`set_snap_controls_to_pixels<class_Viewport_set_snap_controls_to_pixels>`  **(** :ref:`bool<class_bool>` enabled  **)**                                                                                        |
    132. 

  132. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    133. 

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

  134. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    135. 

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

  136. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    137. 

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

  138. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    139. 

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

  140. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    141. 

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

  142. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    143. 

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

  144. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    145. 

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

  146. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    147. 

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

  148. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    149. 

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

  150. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    151. 

  151. | void                                           | :ref:`update_worlds<class_Viewport_update_worlds>`  **(** **)**                                                                                                                                                     |
    152. 

  152. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    153. 

  153. | :ref:`bool<class_bool>`                        | :ref:`use_arvr<class_Viewport_use_arvr>`  **(** **)**                                                                                                                                                               |
    154. 

  154. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    155. 

  155. | void                                           | :ref:`warp_mouse<class_Viewport_warp_mouse>`  **(** :ref:`Vector2<class_vector2>` to_position  **)**                                                                                                                |
    156. 

  156. +------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    157. 

  157. 

  158. Signals
    159. 

  159. -------
    160. 

  160. 

  161. -  **size_changed**  **(** **)**
    162. 

  162. 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.
    163. 

  163. 

  164. 

  165. Member Variables
    166. 

  166. ----------------
    167. 

  167. 

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

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

  170. - :ref:`bool<class_bool>` **audio_listener_enable_3d**
    171. 

  171. - :ref:`int<class_int>` **debug_draw**
    172. 

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

  173. - :ref:`bool<class_bool>` **gui_disable_input**
    174. 

  174. - :ref:`bool<class_bool>` **gui_snap_controls_to_pixels**
    175. 

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

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

  177. - :ref:`bool<class_bool>` **own_world**
    178. 

  178. - :ref:`bool<class_bool>` **physics_object_picking**
    179. 

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

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

  181. - :ref:`bool<class_bool>` **render_target_v_flip**
    182. 

  182. - :ref:`int<class_int>` **shadow_atlas_quad_0**
    183. 

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

  184. - :ref:`int<class_int>` **shadow_atlas_quad_2**
    185. 

  185. - :ref:`int<class_int>` **shadow_atlas_quad_3**
    186. 

  186. - :ref:`int<class_int>` **shadow_atlas_size**
    187. 

  187. - :ref:`Vector2<class_vector2>` **size**
    188. 

  188. - :ref:`bool<class_bool>` **transparent_bg**
    189. 

  189. - :ref:`int<class_int>` **usage**
    190. 

  190. - :ref:`World<class_world>` **world**
    191. 

  191. 

  192. Numeric Constants
    193. 

  193. -----------------
    194. 

  194. 

  195. - **UPDATE_DISABLED** = **0** --- Do not update the render target.
    196. 

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

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

  198. - **UPDATE_ALWAYS** = **3**
    199. 

  199. - **SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED** = **0**
    200. 

  200. - **SHADOW_ATLAS_QUADRANT_SUBDIV_1** = **1**
    201. 

  201. - **SHADOW_ATLAS_QUADRANT_SUBDIV_4** = **2**
    202. 

  202. - **SHADOW_ATLAS_QUADRANT_SUBDIV_16** = **3**
    203. 

  203. - **SHADOW_ATLAS_QUADRANT_SUBDIV_64** = **4**
    204. 

  204. - **SHADOW_ATLAS_QUADRANT_SUBDIV_256** = **5**
    205. 

  205. - **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = **6**
    206. 

  206. - **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7**
    207. 

  207. - **RENDER_INFO_OBJECTS_IN_FRAME** = **0**
    208. 

  208. - **RENDER_INFO_VERTICES_IN_FRAME** = **1**
    209. 

  209. - **RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2**
    210. 

  210. - **RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3**
    211. 

  211. - **RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4**
    212. 

  212. - **RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5**
    213. 

  213. - **RENDER_INFO_MAX** = **6**
    214. 

  214. - **DEBUG_DRAW_DISABLED** = **0**
    215. 

  215. - **DEBUG_DRAW_UNSHADED** = **1**
    216. 

  216. - **DEBUG_DRAW_OVERDRAW** = **2**
    217. 

  217. - **DEBUG_DRAW_WIREFRAME** = **3**
    218. 

  218. - **MSAA_DISABLED** = **0**
    219. 

  219. - **MSAA_2X** = **1**
    220. 

  220. - **MSAA_4X** = **2**
    221. 

  221. - **MSAA_8X** = **3**
    222. 

  222. - **MSAA_16X** = **4**
    223. 

  223. - **USAGE_2D** = **0**
    224. 

  224. - **USAGE_2D_NO_SAMPLING** = **1**
    225. 

  225. - **USAGE_3D** = **2**
    226. 

  226. - **USAGE_3D_NO_EFFECTS** = **3**
    227. 

  227. - **CLEAR_MODE_ALWAYS** = **0**
    228. 

  228. - **CLEAR_MODE_NEVER** = **1**
    229. 

  229. - **CLEAR_MODE_ONLY_NEXT_FRAME** = **2**
    230. 

  230. 

  231. Description
    232. 

  232. -----------
    233. 

  233. 

  234. 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.
    235. 

  235. 

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

  237. 

  238. 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.
    239. 

  239. 

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

  241. 

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

  243. 

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

  245. 

  246. Member Function Description
    247. 

  247. ---------------------------
    248. 

  248. 

  249. .. _class_Viewport_find_world:
    250. 

  250. 

  251. - :ref:`World<class_world>`  **find_world**  **(** **)** const
    252. 

  252. 

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

  254. 

  255. .. _class_Viewport_find_world_2d:
    256. 

  256. 

  257. - :ref:`World2D<class_world2d>`  **find_world_2d**  **(** **)** const
    258. 

  258. 

  259. Return the 2D world of the viewport.
    260. 

  260. 

  261. .. _class_Viewport_get_camera:
    262. 

  262. 

  263. - :ref:`Camera<class_camera>`  **get_camera**  **(** **)** const
    264. 

  264. 

  265. Return the active 3D camera.
    266. 

  266. 

  267. .. _class_Viewport_get_canvas_transform:
    268. 

  268. 

  269. - :ref:`Transform2D<class_transform2d>`  **get_canvas_transform**  **(** **)** const
    270. 

  270. 

  271. Get the canvas transform of the viewport.
    272. 

  272. 

  273. .. _class_Viewport_get_clear_mode:
    274. 

  274. 

  275. - :ref:`int<class_int>`  **get_clear_mode**  **(** **)** const
    276. 

  276. 

  277. .. _class_Viewport_get_debug_draw:
    278. 

  278. 

  279. - :ref:`int<class_int>`  **get_debug_draw**  **(** **)** const
    280. 

  280. 

  281. .. _class_Viewport_get_final_transform:
    282. 

  282. 

  283. - :ref:`Transform2D<class_transform2d>`  **get_final_transform**  **(** **)** const
    284. 

  284. 

  285. Get the total transform of the viewport.
    286. 

  286. 

  287. .. _class_Viewport_get_global_canvas_transform:
    288. 

  288. 

  289. - :ref:`Transform2D<class_transform2d>`  **get_global_canvas_transform**  **(** **)** const
    290. 

  290. 

  291. Get the global canvas transform of the viewport.
    292. 

  292. 

  293. .. _class_Viewport_get_hdr:
    294. 

  294. 

  295. - :ref:`bool<class_bool>`  **get_hdr**  **(** **)** const
    296. 

  296. 

  297. Get whether the rendered texture has filters enabled.
    298. 

  298. 

  299. .. _class_Viewport_get_mouse_position:
    300. 

  300. 

  301. - :ref:`Vector2<class_vector2>`  **get_mouse_position**  **(** **)** const
    302. 

  302. 

  303. Get the mouse position, relative to the viewport.
    304. 

  304. 

  305. .. _class_Viewport_get_msaa:
    306. 

  306. 

  307. - :ref:`int<class_int>`  **get_msaa**  **(** **)** const
    308. 

  308. 

  309. .. _class_Viewport_get_physics_object_picking:
    310. 

  310. 

  311. - :ref:`bool<class_bool>`  **get_physics_object_picking**  **(** **)**
    312. 

  312. 

  313. Get whether picking for all physics objects inside the viewport is enabled.
    314. 

  314. 

  315. .. _class_Viewport_get_render_info:
    316. 

  316. 

  317. - :ref:`int<class_int>`  **get_render_info**  **(** :ref:`int<class_int>` info  **)**
    318. 

  318. 

  319. .. _class_Viewport_get_shadow_atlas_quadrant_subdiv:
    320. 

  320. 

  321. - :ref:`int<class_int>`  **get_shadow_atlas_quadrant_subdiv**  **(** :ref:`int<class_int>` quadrant  **)** const
    322. 

  322. 

  323. .. _class_Viewport_get_shadow_atlas_size:
    324. 

  324. 

  325. - :ref:`int<class_int>`  **get_shadow_atlas_size**  **(** **)** const
    326. 

  326. 

  327. .. _class_Viewport_get_size:
    328. 

  328. 

  329. - :ref:`Vector2<class_vector2>`  **get_size**  **(** **)** const
    330. 

  330. 

  331. 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.
    332. 

  332. 

  333. .. _class_Viewport_get_size_override:
    334. 

  334. 

  335. - :ref:`Vector2<class_vector2>`  **get_size_override**  **(** **)** const
    336. 

  336. 

  337. Get the size override set with :ref:`set_size_override<class_Viewport_set_size_override>`.
    338. 

  338. 

  339. .. _class_Viewport_get_texture:
    340. 

  340. 

  341. - :ref:`ViewportTexture<class_viewporttexture>`  **get_texture**  **(** **)** const
    342. 

  342. 

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

  344. 

  345. .. _class_Viewport_get_update_mode:
    346. 

  346. 

  347. - :ref:`int<class_int>`  **get_update_mode**  **(** **)** const
    348. 

  348. 

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

  350. 

  351. .. _class_Viewport_get_usage:
    352. 

  352. 

  353. - :ref:`int<class_int>`  **get_usage**  **(** **)** const
    354. 

  354. 

  355. .. _class_Viewport_get_vflip:
    356. 

  356. 

  357. - :ref:`bool<class_bool>`  **get_vflip**  **(** **)** const
    358. 

  358. 

  359. Set whether the render target is flipped on the Y axis.
    360. 

  360. 

  361. .. _class_Viewport_get_viewport_rid:
    362. 

  362. 

  363. - :ref:`RID<class_rid>`  **get_viewport_rid**  **(** **)** const
    364. 

  364. 

  365. Get the viewport RID from the :ref:`VisualServer<class_visualserver>`.
    366. 

  366. 

  367. .. _class_Viewport_get_visible_rect:
    368. 

  368. 

  369. - :ref:`Rect2<class_rect2>`  **get_visible_rect**  **(** **)** const
    370. 

  370. 

  371. Return the final, visible rect in global screen coordinates.
    372. 

  372. 

  373. .. _class_Viewport_get_world:
    374. 

  374. 

  375. - :ref:`World<class_world>`  **get_world**  **(** **)** const
    376. 

  376. 

  377. Return the 3D world of the viewport.
    378. 

  378. 

  379. .. _class_Viewport_get_world_2d:
    380. 

  380. 

  381. - :ref:`World2D<class_world2d>`  **get_world_2d**  **(** **)** const
    382. 

  382. 

  383. Return the 2D world of the viewport.
    384. 

  384. 

  385. .. _class_Viewport_gui_get_drag_data:
    386. 

  386. 

  387. - :ref:`Variant<class_variant>`  **gui_get_drag_data**  **(** **)** const
    388. 

  388. 

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

  390. 

  391. .. _class_Viewport_gui_has_modal_stack:
    392. 

  392. 

  393. - :ref:`bool<class_bool>`  **gui_has_modal_stack**  **(** **)** const
    394. 

  394. 

  395. Returs whether there are shown modals on-screen.
    396. 

  396. 

  397. .. _class_Viewport_has_transparent_background:
    398. 

  398. 

  399. - :ref:`bool<class_bool>`  **has_transparent_background**  **(** **)** const
    400. 

  400. 

  401. Return whether the viewport lets whatever is behind it to show.
    402. 

  402. 

  403. .. _class_Viewport_input:
    404. 

  404. 

  405. - void  **input**  **(** :ref:`InputEvent<class_inputevent>` local_event  **)**
    406. 

  406. 

  407. .. _class_Viewport_is_3d_disabled:
    408. 

  408. 

  409. - :ref:`bool<class_bool>`  **is_3d_disabled**  **(** **)** const
    410. 

  410. 

  411. .. _class_Viewport_is_audio_listener:
    412. 

  412. 

  413. - :ref:`bool<class_bool>`  **is_audio_listener**  **(** **)** const
    414. 

  414. 

  415. Returns whether the viewport sends sounds to the speakers.
    416. 

  416. 

  417. .. _class_Viewport_is_audio_listener_2d:
    418. 

  418. 

  419. - :ref:`bool<class_bool>`  **is_audio_listener_2d**  **(** **)** const
    420. 

  420. 

  421. Returns whether the viewport sends soundsfrom 2D emitters to the speakers.
    422. 

  422. 

  423. .. _class_Viewport_is_input_disabled:
    424. 

  424. 

  425. - :ref:`bool<class_bool>`  **is_input_disabled**  **(** **)** const
    426. 

  426. 

  427. Return whether input to the viewport is disabled.
    428. 

  428. 

  429. .. _class_Viewport_is_size_override_enabled:
    430. 

  430. 

  431. - :ref:`bool<class_bool>`  **is_size_override_enabled**  **(** **)** const
    432. 

  432. 

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

  434. 

  435. .. _class_Viewport_is_size_override_stretch_enabled:
    436. 

  436. 

  437. - :ref:`bool<class_bool>`  **is_size_override_stretch_enabled**  **(** **)** const
    438. 

  438. 

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

  440. 

  441. .. _class_Viewport_is_snap_controls_to_pixels_enabled:
    442. 

  442. 

  443. - :ref:`bool<class_bool>`  **is_snap_controls_to_pixels_enabled**  **(** **)** const
    444. 

  444. 

  445. .. _class_Viewport_is_using_own_world:
    446. 

  446. 

  447. - :ref:`bool<class_bool>`  **is_using_own_world**  **(** **)** const
    448. 

  448. 

  449. Return whether the viewport is using a world separate from the parent viewport's world.
    450. 

  450. 

  451. .. _class_Viewport_set_as_audio_listener:
    452. 

  452. 

  453. - void  **set_as_audio_listener**  **(** :ref:`bool<class_bool>` enable  **)**
    454. 

  454. 

  455. Makes the viewport send sounds to the speakers.
    456. 

  456. 

  457. .. _class_Viewport_set_as_audio_listener_2d:
    458. 

  458. 

  459. - void  **set_as_audio_listener_2d**  **(** :ref:`bool<class_bool>` enable  **)**
    460. 

  460. 

  461. Makes the viewport send sounds from 2D emitters to the speakers.
    462. 

  462. 

  463. .. _class_Viewport_set_attach_to_screen_rect:
    464. 

  464. 

  465. - void  **set_attach_to_screen_rect**  **(** :ref:`Rect2<class_rect2>` rect  **)**
    466. 

  466. 

  467. .. _class_Viewport_set_canvas_transform:
    468. 

  468. 

  469. - void  **set_canvas_transform**  **(** :ref:`Transform2D<class_transform2d>` xform  **)**
    470. 

  470. 

  471. 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.
    472. 

  472. 

  473. .. _class_Viewport_set_clear_mode:
    474. 

  474. 

  475. - void  **set_clear_mode**  **(** :ref:`int<class_int>` mode  **)**
    476. 

  476. 

  477. .. _class_Viewport_set_debug_draw:
    478. 

  478. 

  479. - void  **set_debug_draw**  **(** :ref:`int<class_int>` debug_draw  **)**
    480. 

  480. 

  481. .. _class_Viewport_set_disable_3d:
    482. 

  482. 

  483. - void  **set_disable_3d**  **(** :ref:`bool<class_bool>` disable  **)**
    484. 

  484. 

  485. .. _class_Viewport_set_disable_input:
    486. 

  486. 

  487. - void  **set_disable_input**  **(** :ref:`bool<class_bool>` disable  **)**
    488. 

  488. 

  489. Set whether input to the viewport is disabled.
    490. 

  490. 

  491. .. _class_Viewport_set_global_canvas_transform:
    492. 

  492. 

  493. - void  **set_global_canvas_transform**  **(** :ref:`Transform2D<class_transform2d>` xform  **)**
    494. 

  494. 

  495. Set the global canvas transform of the viewport. The canvas transform is relative to this.
    496. 

  496. 

  497. .. _class_Viewport_set_hdr:
    498. 

  498. 

  499. - void  **set_hdr**  **(** :ref:`bool<class_bool>` enable  **)**
    500. 

  500. 

  501. .. _class_Viewport_set_msaa:
    502. 

  502. 

  503. - void  **set_msaa**  **(** :ref:`int<class_int>` msaa  **)**
    504. 

  504. 

  505. .. _class_Viewport_set_physics_object_picking:
    506. 

  506. 

  507. - void  **set_physics_object_picking**  **(** :ref:`bool<class_bool>` enable  **)**
    508. 

  508. 

  509. Enable/disable picking for all physics objects inside the viewport.
    510. 

  510. 

  511. .. _class_Viewport_set_shadow_atlas_quadrant_subdiv:
    512. 

  512. 

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

  514. 

  515. .. _class_Viewport_set_shadow_atlas_size:
    516. 

  516. 

  517. - void  **set_shadow_atlas_size**  **(** :ref:`int<class_int>` size  **)**
    518. 

  518. 

  519. .. _class_Viewport_set_size:
    520. 

  520. 

  521. - void  **set_size**  **(** :ref:`Vector2<class_vector2>` size  **)**
    522. 

  522. 

  523. Set the size of the viewport.
    524. 

  524. 

  525. .. _class_Viewport_set_size_override:
    526. 

  526. 

  527. - 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 )  **)**
    528. 

  528. 

  529. 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.
    530. 

  530. 

  531. .. _class_Viewport_set_size_override_stretch:
    532. 

  532. 

  533. - void  **set_size_override_stretch**  **(** :ref:`bool<class_bool>` enabled  **)**
    534. 

  534. 

  535. Set whether the size override affects stretch as well.
    536. 

  536. 

  537. .. _class_Viewport_set_snap_controls_to_pixels:
    538. 

  538. 

  539. - void  **set_snap_controls_to_pixels**  **(** :ref:`bool<class_bool>` enabled  **)**
    540. 

  540. 

  541. .. _class_Viewport_set_transparent_background:
    542. 

  542. 

  543. - void  **set_transparent_background**  **(** :ref:`bool<class_bool>` enable  **)**
    544. 

  544. 

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

  546. 

  547. .. _class_Viewport_set_update_mode:
    548. 

  548. 

  549. - void  **set_update_mode**  **(** :ref:`int<class_int>` mode  **)**
    550. 

  550. 

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

  552. 

  553. .. _class_Viewport_set_usage:
    554. 

  554. 

  555. - void  **set_usage**  **(** :ref:`int<class_int>` usage  **)**
    556. 

  556. 

  557. .. _class_Viewport_set_use_arvr:
    558. 

  558. 

  559. - void  **set_use_arvr**  **(** :ref:`bool<class_bool>` use  **)**
    560. 

  560. 

  561. If true this viewport will be bound to our ARVR Server.
    562. 

  562. 

  563. If this is our main Godot viewport our AR/VR output will be displayed on screen.
    564. 

  564. 

  565. If output is redirected to an HMD we'll see the output of just one of the eyes without any distortion applied else we'll see the stereo buffer with distortion applied if applicable
    566. 

  566. 

  567. If this is an extra viewport output will only work if redirection to an HMD is supported by the interface. The render target will allow you to use the undistorted output for the right eye in the display.
    568. 

  568. 

  569. .. _class_Viewport_set_use_own_world:
    570. 

  570. 

  571. - void  **set_use_own_world**  **(** :ref:`bool<class_bool>` enable  **)**
    572. 

  572. 

  573. Make the viewport use a world separate from the parent viewport's world.
    574. 

  574. 

  575. .. _class_Viewport_set_vflip:
    576. 

  576. 

  577. - void  **set_vflip**  **(** :ref:`bool<class_bool>` enable  **)**
    578. 

  578. 

  579. Set whether the viewport is flipped on the Y axis.
    580. 

  580. 

  581. .. _class_Viewport_set_world:
    582. 

  582. 

  583. - void  **set_world**  **(** :ref:`World<class_world>` world  **)**
    584. 

  584. 

  585. Change the 3D world of the viewport.
    586. 

  586. 

  587. .. _class_Viewport_set_world_2d:
    588. 

  588. 

  589. - void  **set_world_2d**  **(** :ref:`World2D<class_world2d>` world_2d  **)**
    590. 

  590. 

  591. .. _class_Viewport_unhandled_input:
    592. 

  592. 

  593. - void  **unhandled_input**  **(** :ref:`InputEvent<class_inputevent>` local_event  **)**
    594. 

  594. 

  595. .. _class_Viewport_update_worlds:
    596. 

  596. 

  597. - void  **update_worlds**  **(** **)**
    598. 

  598. 

  599. Force update of the 2D and 3D worlds.
    600. 

  600. 

  601. .. _class_Viewport_use_arvr:
    602. 

  602. 

  603. - :ref:`bool<class_bool>`  **use_arvr**  **(** **)**
    604. 

  604. 

  605. Returns whether this viewport is using our ARVR Server
    606. 

  606. 

  607. .. _class_Viewport_warp_mouse:
    608. 

  608. 

  609. - void  **warp_mouse**  **(** :ref:`Vector2<class_vector2>` to_position  **)**
    610. 

  610. 

  611. Warp the mouse to a position, relative to the viewport.
    612. 

  612. 

  613.