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: 4e6b407826
Branches Tags
godot-docs
/
classes
/
class_viewport.rst

class_viewport.rst 37 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390 
  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. | void                                                   | :ref:`set_rect<class_Viewport_set_rect>`  **(** :ref:`Rect2<class_rect2>` rect  **)**                                                                                                                         |
    23. 

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

  24. | :ref:`Rect2<class_rect2>`                              | :ref:`get_rect<class_Viewport_get_rect>`  **(** **)** const                                                                                                                                                   |
    25. 

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

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

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

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

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

  30. | :ref:`World<class_world>`                              | :ref:`get_world<class_Viewport_get_world>`  **(** **)** const                                                                                                                                                 |
    31. 

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

  32. | :ref:`World<class_world>`                              | :ref:`find_world<class_Viewport_find_world>`  **(** **)** const                                                                                                                                               |
    33. 

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

  34. | void                                                   | :ref:`set_canvas_transform<class_Viewport_set_canvas_transform>`  **(** :ref:`Matrix32<class_matrix32>` xform  **)**                                                                                          |
    35. 

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

  36. | :ref:`Matrix32<class_matrix32>`                        | :ref:`get_canvas_transform<class_Viewport_get_canvas_transform>`  **(** **)** const                                                                                                                           |
    37. 

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

  38. | void                                                   | :ref:`set_global_canvas_transform<class_Viewport_set_global_canvas_transform>`  **(** :ref:`Matrix32<class_matrix32>` xform  **)**                                                                            |
    39. 

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

  40. | :ref:`Matrix32<class_matrix32>`                        | :ref:`get_global_canvas_transform<class_Viewport_get_global_canvas_transform>`  **(** **)** const                                                                                                             |
    41. 

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

  42. | :ref:`Matrix32<class_matrix32>`                        | :ref:`get_final_transform<class_Viewport_get_final_transform>`  **(** **)** const                                                                                                                             |
    43. 

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

  44. | :ref:`Rect2<class_rect2>`                              | :ref:`get_visible_rect<class_Viewport_get_visible_rect>`  **(** **)** const                                                                                                                                   |
    45. 

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

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

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

  48. | :ref:`bool<class_bool>`                                | :ref:`has_transparent_background<class_Viewport_has_transparent_background>`  **(** **)** const                                                                                                               |
    49. 

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

  50. | 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)  **)** |
    51. 

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

  52. | :ref:`Vector2<class_vector2>`                          | :ref:`get_size_override<class_Viewport_get_size_override>`  **(** **)** const                                                                                                                                 |
    53. 

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

  54. | :ref:`bool<class_bool>`                                | :ref:`is_size_override_enabled<class_Viewport_is_size_override_enabled>`  **(** **)** const                                                                                                                   |
    55. 

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

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

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

  58. | :ref:`bool<class_bool>`                                | :ref:`is_size_override_stretch_enabled<class_Viewport_is_size_override_stretch_enabled>`  **(** **)** const                                                                                                   |
    59. 

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

  60. | void                                                   | :ref:`queue_screen_capture<class_Viewport_queue_screen_capture>`  **(** **)**                                                                                                                                 |
    61. 

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

  62. | :ref:`Image<class_image>`                              | :ref:`get_screen_capture<class_Viewport_get_screen_capture>`  **(** **)** const                                                                                                                               |
    63. 

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

  64. | void                                                   | :ref:`set_as_render_target<class_Viewport_set_as_render_target>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                 |
    65. 

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

  66. | :ref:`bool<class_bool>`                                | :ref:`is_set_as_render_target<class_Viewport_is_set_as_render_target>`  **(** **)** const                                                                                                                     |
    67. 

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

  68. | void                                                   | :ref:`set_render_target_vflip<class_Viewport_set_render_target_vflip>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                           |
    69. 

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

  70. | :ref:`bool<class_bool>`                                | :ref:`get_render_target_vflip<class_Viewport_get_render_target_vflip>`  **(** **)** const                                                                                                                     |
    71. 

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

  72. | void                                                   | :ref:`set_render_target_clear_on_new_frame<class_Viewport_set_render_target_clear_on_new_frame>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                 |
    73. 

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

  74. | :ref:`bool<class_bool>`                                | :ref:`get_render_target_clear_on_new_frame<class_Viewport_get_render_target_clear_on_new_frame>`  **(** **)** const                                                                                           |
    75. 

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

  76. | void                                                   | :ref:`render_target_clear<class_Viewport_render_target_clear>`  **(** **)**                                                                                                                                   |
    77. 

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

  78. | void                                                   | :ref:`set_render_target_filter<class_Viewport_set_render_target_filter>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                         |
    79. 

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

  80. | :ref:`bool<class_bool>`                                | :ref:`get_render_target_filter<class_Viewport_get_render_target_filter>`  **(** **)** const                                                                                                                   |
    81. 

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

  82. | void                                                   | :ref:`set_render_target_gen_mipmaps<class_Viewport_set_render_target_gen_mipmaps>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                               |
    83. 

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

  84. | :ref:`bool<class_bool>`                                | :ref:`get_render_target_gen_mipmaps<class_Viewport_get_render_target_gen_mipmaps>`  **(** **)** const                                                                                                         |
    85. 

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

  86. | void                                                   | :ref:`set_render_target_update_mode<class_Viewport_set_render_target_update_mode>`  **(** :ref:`int<class_int>` mode  **)**                                                                                   |
    87. 

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

  88. | :ref:`int<class_int>`                                  | :ref:`get_render_target_update_mode<class_Viewport_get_render_target_update_mode>`  **(** **)** const                                                                                                         |
    89. 

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

  90. | :ref:`RenderTargetTexture<class_rendertargettexture>`  | :ref:`get_render_target_texture<class_Viewport_get_render_target_texture>`  **(** **)** const                                                                                                                 |
    91. 

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

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

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

  94. | :ref:`bool<class_bool>`                                | :ref:`get_physics_object_picking<class_Viewport_get_physics_object_picking>`  **(** **)**                                                                                                                     |
    95. 

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

  96. | :ref:`RID<class_rid>`                                  | :ref:`get_viewport<class_Viewport_get_viewport>`  **(** **)** const                                                                                                                                           |
    97. 

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

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

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

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

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

  102. | void                                                   | :ref:`update_worlds<class_Viewport_update_worlds>`  **(** **)**                                                                                                                                               |
    103. 

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

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

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

  106. | :ref:`bool<class_bool>`                                | :ref:`is_using_own_world<class_Viewport_is_using_own_world>`  **(** **)** const                                                                                                                               |
    107. 

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

  108. | :ref:`Camera<class_camera>`                            | :ref:`get_camera<class_Viewport_get_camera>`  **(** **)** const                                                                                                                                               |
    109. 

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

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

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

  112. | :ref:`bool<class_bool>`                                | :ref:`is_audio_listener<class_Viewport_is_audio_listener>`  **(** **)** const                                                                                                                                 |
    113. 

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

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

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

  116. | :ref:`bool<class_bool>`                                | :ref:`is_audio_listener_2d<class_Viewport_is_audio_listener_2d>`  **(** **)** const                                                                                                                           |
    117. 

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

  118. | void                                                   | :ref:`set_render_target_to_screen_rect<class_Viewport_set_render_target_to_screen_rect>`  **(** :ref:`Rect2<class_rect2>` rect  **)**                                                                         |
    119. 

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

  120. | :ref:`Vector2<class_vector2>`                          | :ref:`get_mouse_pos<class_Viewport_get_mouse_pos>`  **(** **)** const                                                                                                                                         |
    121. 

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

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

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

  124. | :ref:`bool<class_bool>`                                | :ref:`gui_has_modal_stack<class_Viewport_gui_has_modal_stack>`  **(** **)** const                                                                                                                             |
    125. 

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

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

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

  128. | :ref:`bool<class_bool>`                                | :ref:`is_input_disabled<class_Viewport_is_input_disabled>`  **(** **)** const                                                                                                                                 |
    129. 

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

  130. 

  131. Signals
    132. 

  132. -------
    133. 

  133. 

  134. -  **size_changed**  **(** **)**
    135. 

  135. 

  136. Numeric Constants
    137. 

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

  138. 

  139. - **RENDER_TARGET_UPDATE_DISABLED** = **0**
    140. 

  140. - **RENDER_TARGET_UPDATE_ONCE** = **1**
    141. 

  141. - **RENDER_TARGET_UPDATE_WHEN_VISIBLE** = **2**
    142. 

  142. - **RENDER_TARGET_UPDATE_ALWAYS** = **3**
    143. 

  143. 

  144. Description
    145. 

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

  146. 

  147. 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.
    148. 

  148. 

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

  150. 

  151. 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.
    152. 

  152. 

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

  154. 

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

  156. 

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

  158. 

  159. Member Function Description
    160. 

  160. ---------------------------
    161. 

  161. 

  162. .. _class_Viewport_set_rect:
    163. 

  163. 

  164. - void  **set_rect**  **(** :ref:`Rect2<class_rect2>` rect  **)**
    165. 

  165. 

  166. Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent.
    167. 

  167. 

  168. .. _class_Viewport_get_rect:
    169. 

  169. 

  170. - :ref:`Rect2<class_rect2>`  **get_rect**  **(** **)** const
    171. 

  171. 

  172. 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.
    173. 

  173. 

  174. .. _class_Viewport_find_world_2d:
    175. 

  175. 

  176. - :ref:`World2D<class_world2d>`  **find_world_2d**  **(** **)** const
    177. 

  177. 

  178. .. _class_Viewport_set_world:
    179. 

  179. 

  180. - void  **set_world**  **(** :ref:`World<class_world>` world  **)**
    181. 

  181. 

  182. .. _class_Viewport_get_world:
    183. 

  183. 

  184. - :ref:`World<class_world>`  **get_world**  **(** **)** const
    185. 

  185. 

  186. .. _class_Viewport_find_world:
    187. 

  187. 

  188. - :ref:`World<class_world>`  **find_world**  **(** **)** const
    189. 

  189. 

  190. .. _class_Viewport_set_canvas_transform:
    191. 

  191. 

  192. - void  **set_canvas_transform**  **(** :ref:`Matrix32<class_matrix32>` xform  **)**
    193. 

  193. 

  194. .. _class_Viewport_get_canvas_transform:
    195. 

  195. 

  196. - :ref:`Matrix32<class_matrix32>`  **get_canvas_transform**  **(** **)** const
    197. 

  197. 

  198. .. _class_Viewport_set_global_canvas_transform:
    199. 

  199. 

  200. - void  **set_global_canvas_transform**  **(** :ref:`Matrix32<class_matrix32>` xform  **)**
    201. 

  201. 

  202. .. _class_Viewport_get_global_canvas_transform:
    203. 

  203. 

  204. - :ref:`Matrix32<class_matrix32>`  **get_global_canvas_transform**  **(** **)** const
    205. 

  205. 

  206. .. _class_Viewport_get_final_transform:
    207. 

  207. 

  208. - :ref:`Matrix32<class_matrix32>`  **get_final_transform**  **(** **)** const
    209. 

  209. 

  210. .. _class_Viewport_get_visible_rect:
    211. 

  211. 

  212. - :ref:`Rect2<class_rect2>`  **get_visible_rect**  **(** **)** const
    213. 

  213. 

  214. Return the final, visible rect in global screen coordinates.
    215. 

  215. 

  216. .. _class_Viewport_set_transparent_background:
    217. 

  217. 

  218. - void  **set_transparent_background**  **(** :ref:`bool<class_bool>` enable  **)**
    219. 

  219. 

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

  221. 

  222. .. _class_Viewport_has_transparent_background:
    223. 

  223. 

  224. - :ref:`bool<class_bool>`  **has_transparent_background**  **(** **)** const
    225. 

  225. 

  226. Return whether the viewport lets whatever is behind it to show.
    227. 

  227. 

  228. .. _class_Viewport_set_size_override:
    229. 

  229. 

  230. - 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)  **)**
    231. 

  231. 

  232. .. _class_Viewport_get_size_override:
    233. 

  233. 

  234. - :ref:`Vector2<class_vector2>`  **get_size_override**  **(** **)** const
    235. 

  235. 

  236. .. _class_Viewport_is_size_override_enabled:
    237. 

  237. 

  238. - :ref:`bool<class_bool>`  **is_size_override_enabled**  **(** **)** const
    239. 

  239. 

  240. .. _class_Viewport_set_size_override_stretch:
    241. 

  241. 

  242. - void  **set_size_override_stretch**  **(** :ref:`bool<class_bool>` enabled  **)**
    243. 

  243. 

  244. .. _class_Viewport_is_size_override_stretch_enabled:
    245. 

  245. 

  246. - :ref:`bool<class_bool>`  **is_size_override_stretch_enabled**  **(** **)** const
    247. 

  247. 

  248. .. _class_Viewport_queue_screen_capture:
    249. 

  249. 

  250. - void  **queue_screen_capture**  **(** **)**
    251. 

  251. 

  252. .. _class_Viewport_get_screen_capture:
    253. 

  253. 

  254. - :ref:`Image<class_image>`  **get_screen_capture**  **(** **)** const
    255. 

  255. 

  256. .. _class_Viewport_set_as_render_target:
    257. 

  257. 

  258. - void  **set_as_render_target**  **(** :ref:`bool<class_bool>` enable  **)**
    259. 

  259. 

  260. .. _class_Viewport_is_set_as_render_target:
    261. 

  261. 

  262. - :ref:`bool<class_bool>`  **is_set_as_render_target**  **(** **)** const
    263. 

  263. 

  264. .. _class_Viewport_set_render_target_vflip:
    265. 

  265. 

  266. - void  **set_render_target_vflip**  **(** :ref:`bool<class_bool>` enable  **)**
    267. 

  267. 

  268. .. _class_Viewport_get_render_target_vflip:
    269. 

  269. 

  270. - :ref:`bool<class_bool>`  **get_render_target_vflip**  **(** **)** const
    271. 

  271. 

  272. .. _class_Viewport_set_render_target_clear_on_new_frame:
    273. 

  273. 

  274. - void  **set_render_target_clear_on_new_frame**  **(** :ref:`bool<class_bool>` enable  **)**
    275. 

  275. 

  276. .. _class_Viewport_get_render_target_clear_on_new_frame:
    277. 

  277. 

  278. - :ref:`bool<class_bool>`  **get_render_target_clear_on_new_frame**  **(** **)** const
    279. 

  279. 

  280. .. _class_Viewport_render_target_clear:
    281. 

  281. 

  282. - void  **render_target_clear**  **(** **)**
    283. 

  283. 

  284. .. _class_Viewport_set_render_target_filter:
    285. 

  285. 

  286. - void  **set_render_target_filter**  **(** :ref:`bool<class_bool>` enable  **)**
    287. 

  287. 

  288. .. _class_Viewport_get_render_target_filter:
    289. 

  289. 

  290. - :ref:`bool<class_bool>`  **get_render_target_filter**  **(** **)** const
    291. 

  291. 

  292. .. _class_Viewport_set_render_target_gen_mipmaps:
    293. 

  293. 

  294. - void  **set_render_target_gen_mipmaps**  **(** :ref:`bool<class_bool>` enable  **)**
    295. 

  295. 

  296. .. _class_Viewport_get_render_target_gen_mipmaps:
    297. 

  297. 

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

  299. 

  300. .. _class_Viewport_set_render_target_update_mode:
    301. 

  301. 

  302. - void  **set_render_target_update_mode**  **(** :ref:`int<class_int>` mode  **)**
    303. 

  303. 

  304. .. _class_Viewport_get_render_target_update_mode:
    305. 

  305. 

  306. - :ref:`int<class_int>`  **get_render_target_update_mode**  **(** **)** const
    307. 

  307. 

  308. .. _class_Viewport_get_render_target_texture:
    309. 

  309. 

  310. - :ref:`RenderTargetTexture<class_rendertargettexture>`  **get_render_target_texture**  **(** **)** const
    311. 

  311. 

  312. .. _class_Viewport_set_physics_object_picking:
    313. 

  313. 

  314. - void  **set_physics_object_picking**  **(** :ref:`bool<class_bool>` enable  **)**
    315. 

  315. 

  316. .. _class_Viewport_get_physics_object_picking:
    317. 

  317. 

  318. - :ref:`bool<class_bool>`  **get_physics_object_picking**  **(** **)**
    319. 

  319. 

  320. .. _class_Viewport_get_viewport:
    321. 

  321. 

  322. - :ref:`RID<class_rid>`  **get_viewport**  **(** **)** const
    323. 

  323. 

  324. Get the viewport RID from the visual server.
    325. 

  325. 

  326. .. _class_Viewport_input:
    327. 

  327. 

  328. - void  **input**  **(** :ref:`InputEvent<class_inputevent>` local_event  **)**
    329. 

  329. 

  330. .. _class_Viewport_unhandled_input:
    331. 

  331. 

  332. - void  **unhandled_input**  **(** :ref:`InputEvent<class_inputevent>` local_event  **)**
    333. 

  333. 

  334. .. _class_Viewport_update_worlds:
    335. 

  335. 

  336. - void  **update_worlds**  **(** **)**
    337. 

  337. 

  338. .. _class_Viewport_set_use_own_world:
    339. 

  339. 

  340. - void  **set_use_own_world**  **(** :ref:`bool<class_bool>` enable  **)**
    341. 

  341. 

  342. .. _class_Viewport_is_using_own_world:
    343. 

  343. 

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

  345. 

  346. .. _class_Viewport_get_camera:
    347. 

  347. 

  348. - :ref:`Camera<class_camera>`  **get_camera**  **(** **)** const
    349. 

  349. 

  350. .. _class_Viewport_set_as_audio_listener:
    351. 

  351. 

  352. - void  **set_as_audio_listener**  **(** :ref:`bool<class_bool>` enable  **)**
    353. 

  353. 

  354. .. _class_Viewport_is_audio_listener:
    355. 

  355. 

  356. - :ref:`bool<class_bool>`  **is_audio_listener**  **(** **)** const
    357. 

  357. 

  358. .. _class_Viewport_set_as_audio_listener_2d:
    359. 

  359. 

  360. - void  **set_as_audio_listener_2d**  **(** :ref:`bool<class_bool>` enable  **)**
    361. 

  361. 

  362. .. _class_Viewport_is_audio_listener_2d:
    363. 

  363. 

  364. - :ref:`bool<class_bool>`  **is_audio_listener_2d**  **(** **)** const
    365. 

  365. 

  366. .. _class_Viewport_set_render_target_to_screen_rect:
    367. 

  367. 

  368. - void  **set_render_target_to_screen_rect**  **(** :ref:`Rect2<class_rect2>` rect  **)**
    369. 

  369. 

  370. .. _class_Viewport_get_mouse_pos:
    371. 

  371. 

  372. - :ref:`Vector2<class_vector2>`  **get_mouse_pos**  **(** **)** const
    373. 

  373. 

  374. .. _class_Viewport_warp_mouse:
    375. 

  375. 

  376. - void  **warp_mouse**  **(** :ref:`Vector2<class_vector2>` to_pos  **)**
    377. 

  377. 

  378. .. _class_Viewport_gui_has_modal_stack:
    379. 

  379. 

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

  381. 

  382. .. _class_Viewport_set_disable_input:
    383. 

  383. 

  384. - void  **set_disable_input**  **(** :ref:`bool<class_bool>` disable  **)**
    385. 

  385. 

  386. .. _class_Viewport_is_input_disabled:
    387. 

  387. 

  388. - :ref:`bool<class_bool>`  **is_input_disabled**  **(** **)** const
    389. 

  389. 

  390.