|
@@ -18,71 +18,75 @@ Camera node for 2D scenes.
|
|
|
Member Functions
|
|
|
----------------
|
|
|
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`int<class_int>` | :ref:`get_anchor_mode<class_Camera2D_get_anchor_mode>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`Vector2<class_vector2>` | :ref:`get_camera_pos<class_Camera2D_get_camera_pos>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`float<class_float>` | :ref:`get_drag_margin<class_Camera2D_get_drag_margin>` **(** :ref:`int<class_int>` margin **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`float<class_float>` | :ref:`get_follow_smoothing<class_Camera2D_get_follow_smoothing>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`int<class_int>` | :ref:`get_limit<class_Camera2D_get_limit>` **(** :ref:`int<class_int>` margin **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Camera2D_get_offset>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`Vector2<class_vector2>` | :ref:`get_zoom<class_Camera2D_get_zoom>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera2D_is_current>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`bool<class_bool>` | :ref:`is_follow_smoothing_enabled<class_Camera2D_is_follow_smoothing_enabled>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`bool<class_bool>` | :ref:`is_h_drag_enabled<class_Camera2D_is_h_drag_enabled>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`bool<class_bool>` | :ref:`is_rotating<class_Camera2D_is_rotating>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| :ref:`bool<class_bool>` | :ref:`is_v_drag_enabled<class_Camera2D_is_v_drag_enabled>` **(** **)** const |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_anchor_mode<class_Camera2D_set_anchor_mode>` **(** :ref:`int<class_int>` anchor_mode **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_drag_margin<class_Camera2D_set_drag_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_enable_follow_smoothing<class_Camera2D_set_enable_follow_smoothing>` **(** :ref:`bool<class_bool>` follow_smoothing **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_follow_smoothing<class_Camera2D_set_follow_smoothing>` **(** :ref:`float<class_float>` follow_smoothing **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_h_drag_enabled<class_Camera2D_set_h_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_limit<class_Camera2D_set_limit>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_offset<class_Camera2D_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_rotating<class_Camera2D_set_rotating>` **(** :ref:`bool<class_bool>` rotating **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_v_drag_enabled<class_Camera2D_set_v_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
-| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
|
|
|
-+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`int<class_int>` | :ref:`get_anchor_mode<class_Camera2D_get_anchor_mode>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`Vector2<class_vector2>` | :ref:`get_camera_pos<class_Camera2D_get_camera_pos>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`Viewport<class_viewport>` | :ref:`get_custom_viewport<class_Camera2D_get_custom_viewport>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_drag_margin<class_Camera2D_get_drag_margin>` **(** :ref:`int<class_int>` margin **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_follow_smoothing<class_Camera2D_get_follow_smoothing>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`int<class_int>` | :ref:`get_limit<class_Camera2D_get_limit>` **(** :ref:`int<class_int>` margin **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Camera2D_get_offset>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`Vector2<class_vector2>` | :ref:`get_zoom<class_Camera2D_get_zoom>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera2D_is_current>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`bool<class_bool>` | :ref:`is_follow_smoothing_enabled<class_Camera2D_is_follow_smoothing_enabled>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`bool<class_bool>` | :ref:`is_h_drag_enabled<class_Camera2D_is_h_drag_enabled>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`bool<class_bool>` | :ref:`is_rotating<class_Camera2D_is_rotating>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`bool<class_bool>` | :ref:`is_v_drag_enabled<class_Camera2D_is_v_drag_enabled>` **(** **)** const |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_anchor_mode<class_Camera2D_set_anchor_mode>` **(** :ref:`int<class_int>` anchor_mode **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_custom_viewport<class_Camera2D_set_custom_viewport>` **(** :ref:`Viewport<class_viewport>` viewport **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_drag_margin<class_Camera2D_set_drag_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_enable_follow_smoothing<class_Camera2D_set_enable_follow_smoothing>` **(** :ref:`bool<class_bool>` follow_smoothing **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_follow_smoothing<class_Camera2D_set_follow_smoothing>` **(** :ref:`float<class_float>` follow_smoothing **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_h_drag_enabled<class_Camera2D_set_h_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_limit<class_Camera2D_set_limit>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_offset<class_Camera2D_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_rotating<class_Camera2D_set_rotating>` **(** :ref:`bool<class_bool>` rotating **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_v_drag_enabled<class_Camera2D_set_v_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
|
|
|
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
Numeric Constants
|
|
|
-----------------
|
|
@@ -130,6 +134,12 @@ Return the camera position.
|
|
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_camera_screen_center** **(** **)** const
|
|
|
|
|
|
+.. _class_Camera2D_get_custom_viewport:
|
|
|
+
|
|
|
+- :ref:`Viewport<class_viewport>` **get_custom_viewport** **(** **)** const
|
|
|
+
|
|
|
+Return the viewport RID for this layer.
|
|
|
+
|
|
|
.. _class_Camera2D_get_drag_margin:
|
|
|
|
|
|
- :ref:`float<class_float>` **get_drag_margin** **(** :ref:`int<class_int>` margin **)** const
|
|
@@ -204,6 +214,10 @@ This has no effect if smoothing is disabled.
|
|
|
|
|
|
- void **set_anchor_mode** **(** :ref:`int<class_int>` anchor_mode **)**
|
|
|
|
|
|
+.. _class_Camera2D_set_custom_viewport:
|
|
|
+
|
|
|
+- void **set_custom_viewport** **(** :ref:`Viewport<class_viewport>` viewport **)**
|
|
|
+
|
|
|
.. _class_Camera2D_set_drag_margin:
|
|
|
|
|
|
- void **set_drag_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)**
|