mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
2708 lines
194 KiB
ReStructuredText
2708 lines
194 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_Viewport:
|
||
|
||
Viewport
|
||
========
|
||
|
||
**Наследует:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||
|
||
**Наследуется от:** :ref:`SubViewport<class_SubViewport>`, :ref:`Window<class_Window>`
|
||
|
||
Абстрактный базовый класс для вьюпортов (viewports). Инкапсулирует рисование и взаимодействие с игровым миром.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Описание
|
||
----------------
|
||
|
||
**Viewport** создает другой вид на экране или подвид внутри другого viewport. Дочерние 2D-узлы будут отображаться на нем, и дочерние 3D-узлы Camera3D также будут визуализироваться на нем.
|
||
|
||
При желании viewport может иметь свой собственный 2D- или 3D-мир, поэтому он не делится тем, что он рисует, с другими viewport.
|
||
|
||
Viewports также могут быть выбраны в качестве аудиослушателей, поэтому они генерируют позиционный звук в зависимости от дочерней 2D- или 3D-камеры.
|
||
|
||
Кроме того, viewports можно назначать разным экранам, если у устройств несколько экранов.
|
||
|
||
Наконец, viewports также могут вести себя как цели рендеринга, в этом случае они не будут видны, если для рисования не используется связанная текстура.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Обучающие материалы
|
||
--------------------------------------
|
||
|
||
- :doc:`Использовать Viewports <../tutorials/rendering/viewports>`
|
||
|
||
- :doc:`Преобразования области просмотра и холста <../tutorials/2d/2d_transforms>`
|
||
|
||
- `Демонстрация графического интерфейса пользователя в 3D-окне просмотра <https://godotengine.org/asset-library/asset/2807>`__
|
||
|
||
- `Демонстрация 3D в 2D-виде <https://godotengine.org/asset-library/asset/2804>`__
|
||
|
||
- `Демонстрация 2D в 3D-виде <https://godotengine.org/asset-library/asset/2803>`__
|
||
|
||
- `Демо-версия захвата экрана <https://godotengine.org/asset-library/asset/2808>`__
|
||
|
||
- `Демонстрация динамического разделения экрана <https://godotengine.org/asset-library/asset/2806>`__
|
||
|
||
- `Демонстрация масштабирования 3D-разрешения <https://godotengine.org/asset-library/asset/2805>`__
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Свойства
|
||
----------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` | :ref:`anisotropic_filtering_level<class_Viewport_property_anisotropic_filtering_level>` | ``2`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`audio_listener_enable_2d<class_Viewport_property_audio_listener_enable_2d>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`audio_listener_enable_3d<class_Viewport_property_audio_listener_enable_3d>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`canvas_cull_mask<class_Viewport_property_canvas_cull_mask>` | ``4294967295`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` | :ref:`canvas_item_default_texture_filter<class_Viewport_property_canvas_item_default_texture_filter>` | ``1`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>` | :ref:`canvas_item_default_texture_repeat<class_Viewport_property_canvas_item_default_texture_repeat>` | ``0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`Transform2D<class_Transform2D>` | :ref:`canvas_transform<class_Viewport_property_canvas_transform>` | |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`DebugDraw<enum_Viewport_DebugDraw>` | :ref:`debug_draw<class_Viewport_property_debug_draw>` | ``0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`disable_3d<class_Viewport_property_disable_3d>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`fsr_sharpness<class_Viewport_property_fsr_sharpness>` | ``0.2`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`Transform2D<class_Transform2D>` | :ref:`global_canvas_transform<class_Viewport_property_global_canvas_transform>` | |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`gui_disable_input<class_Viewport_property_gui_disable_input>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`gui_drag_threshold<class_Viewport_property_gui_drag_threshold>` | ``10`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`gui_embed_subwindows<class_Viewport_property_gui_embed_subwindows>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`gui_snap_controls_to_pixels<class_Viewport_property_gui_snap_controls_to_pixels>` | ``true`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`handle_input_locally<class_Viewport_property_handle_input_locally>` | ``true`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`mesh_lod_threshold<class_Viewport_property_mesh_lod_threshold>` | ``1.0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`MSAA<enum_Viewport_MSAA>` | :ref:`msaa_2d<class_Viewport_property_msaa_2d>` | ``0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`MSAA<enum_Viewport_MSAA>` | :ref:`msaa_3d<class_Viewport_property_msaa_3d>` | ``0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`oversampling<class_Viewport_property_oversampling>` | ``true`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`oversampling_override<class_Viewport_property_oversampling_override>` | ``0.0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`own_world_3d<class_Viewport_property_own_world_3d>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` | physics_interpolation_mode | ``1`` (overrides :ref:`Node<class_Node_property_physics_interpolation_mode>`) |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`physics_object_picking<class_Viewport_property_physics_object_picking>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`physics_object_picking_first_only<class_Viewport_property_physics_object_picking_first_only>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`physics_object_picking_sort<class_Viewport_property_physics_object_picking_sort>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`positional_shadow_atlas_16_bits<class_Viewport_property_positional_shadow_atlas_16_bits>` | ``true`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` | :ref:`positional_shadow_atlas_quad_0<class_Viewport_property_positional_shadow_atlas_quad_0>` | ``2`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` | :ref:`positional_shadow_atlas_quad_1<class_Viewport_property_positional_shadow_atlas_quad_1>` | ``2`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` | :ref:`positional_shadow_atlas_quad_2<class_Viewport_property_positional_shadow_atlas_quad_2>` | ``3`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` | :ref:`positional_shadow_atlas_quad_3<class_Viewport_property_positional_shadow_atlas_quad_3>` | ``4`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`positional_shadow_atlas_size<class_Viewport_property_positional_shadow_atlas_size>` | ``2048`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` | :ref:`scaling_3d_mode<class_Viewport_property_scaling_3d_mode>` | ``0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`scaling_3d_scale<class_Viewport_property_scaling_3d_scale>` | ``1.0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>` | :ref:`screen_space_aa<class_Viewport_property_screen_space_aa>` | ``0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`SDFOversize<enum_Viewport_SDFOversize>` | :ref:`sdf_oversize<class_Viewport_property_sdf_oversize>` | ``1`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`SDFScale<enum_Viewport_SDFScale>` | :ref:`sdf_scale<class_Viewport_property_sdf_scale>` | ``1`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`snap_2d_transforms_to_pixel<class_Viewport_property_snap_2d_transforms_to_pixel>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`snap_2d_vertices_to_pixel<class_Viewport_property_snap_2d_vertices_to_pixel>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`texture_mipmap_bias<class_Viewport_property_texture_mipmap_bias>` | ``0.0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`transparent_bg<class_Viewport_property_transparent_bg>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`use_debanding<class_Viewport_property_use_debanding>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`use_hdr_2d<class_Viewport_property_use_hdr_2d>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`use_occlusion_culling<class_Viewport_property_use_occlusion_culling>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`use_taa<class_Viewport_property_use_taa>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`use_xr<class_Viewport_property_use_xr>` | ``false`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`VRSMode<enum_Viewport_VRSMode>` | :ref:`vrs_mode<class_Viewport_property_vrs_mode>` | ``0`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`Texture2D<class_Texture2D>` | :ref:`vrs_texture<class_Viewport_property_vrs_texture>` | |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>` | :ref:`vrs_update_mode<class_Viewport_property_vrs_update_mode>` | ``1`` |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`World2D<class_World2D>` | :ref:`world_2d<class_Viewport_property_world_2d>` | |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
| :ref:`World3D<class_World3D>` | :ref:`world_3d<class_Viewport_property_world_3d>` | |
|
||
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Методы
|
||
------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`World2D<class_World2D>` | :ref:`find_world_2d<class_Viewport_method_find_world_2d>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`World3D<class_World3D>` | :ref:`find_world_3d<class_Viewport_method_find_world_3d>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`AudioListener2D<class_AudioListener2D>` | :ref:`get_audio_listener_2d<class_Viewport_method_get_audio_listener_2d>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`AudioListener3D<class_AudioListener3D>` | :ref:`get_audio_listener_3d<class_Viewport_method_get_audio_listener_3d>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Camera2D<class_Camera2D>` | :ref:`get_camera_2d<class_Viewport_method_get_camera_2d>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Camera3D<class_Camera3D>` | :ref:`get_camera_3d<class_Viewport_method_get_camera_3d>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`get_canvas_cull_mask_bit<class_Viewport_method_get_canvas_cull_mask_bit>`\ (\ layer\: :ref:`int<class_int>`\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>`\[:ref:`Window<class_Window>`\] | :ref:`get_embedded_subwindows<class_Viewport_method_get_embedded_subwindows>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_final_transform<class_Viewport_method_get_final_transform>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2<class_Vector2>` | :ref:`get_mouse_position<class_Viewport_method_get_mouse_position>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_oversampling<class_Viewport_method_get_oversampling>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` | :ref:`get_positional_shadow_atlas_quadrant_subdiv<class_Viewport_method_get_positional_shadow_atlas_quadrant_subdiv>`\ (\ quadrant\: :ref:`int<class_int>`\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_render_info<class_Viewport_method_get_render_info>`\ (\ type\: :ref:`RenderInfoType<enum_Viewport_RenderInfoType>`, info\: :ref:`RenderInfo<enum_Viewport_RenderInfo>`\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_screen_transform<class_Viewport_method_get_screen_transform>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Transform2D<class_Transform2D>` | :ref:`get_stretch_transform<class_Viewport_method_get_stretch_transform>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`ViewportTexture<class_ViewportTexture>` | :ref:`get_texture<class_Viewport_method_get_texture>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`get_viewport_rid<class_Viewport_method_get_viewport_rid>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Rect2<class_Rect2>` | :ref:`get_visible_rect<class_Viewport_method_get_visible_rect>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`gui_cancel_drag<class_Viewport_method_gui_cancel_drag>`\ (\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Variant<class_Variant>` | :ref:`gui_get_drag_data<class_Viewport_method_gui_get_drag_data>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`gui_get_drag_description<class_Viewport_method_gui_get_drag_description>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Control<class_Control>` | :ref:`gui_get_focus_owner<class_Viewport_method_gui_get_focus_owner>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Control<class_Control>` | :ref:`gui_get_hovered_control<class_Viewport_method_gui_get_hovered_control>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`gui_is_drag_successful<class_Viewport_method_gui_is_drag_successful>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`gui_is_dragging<class_Viewport_method_gui_is_dragging>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`gui_release_focus<class_Viewport_method_gui_release_focus>`\ (\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`gui_set_drag_description<class_Viewport_method_gui_set_drag_description>`\ (\ description\: :ref:`String<class_String>`\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_input_handled<class_Viewport_method_is_input_handled>`\ (\ ) |const| |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`notify_mouse_entered<class_Viewport_method_notify_mouse_entered>`\ (\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`notify_mouse_exited<class_Viewport_method_notify_mouse_exited>`\ (\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`push_input<class_Viewport_method_push_input>`\ (\ event\: :ref:`InputEvent<class_InputEvent>`, in_local_coords\: :ref:`bool<class_bool>` = false\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`push_text_input<class_Viewport_method_push_text_input>`\ (\ text\: :ref:`String<class_String>`\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`push_unhandled_input<class_Viewport_method_push_unhandled_input>`\ (\ event\: :ref:`InputEvent<class_InputEvent>`, in_local_coords\: :ref:`bool<class_bool>` = false\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_canvas_cull_mask_bit<class_Viewport_method_set_canvas_cull_mask_bit>`\ (\ layer\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_input_as_handled<class_Viewport_method_set_input_as_handled>`\ (\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_positional_shadow_atlas_quadrant_subdiv<class_Viewport_method_set_positional_shadow_atlas_quadrant_subdiv>`\ (\ quadrant\: :ref:`int<class_int>`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>`\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`update_mouse_cursor_state<class_Viewport_method_update_mouse_cursor_state>`\ (\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`warp_mouse<class_Viewport_method_warp_mouse>`\ (\ position\: :ref:`Vector2<class_Vector2>`\ ) |
|
||
+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Сигналы
|
||
--------------
|
||
|
||
.. _class_Viewport_signal_gui_focus_changed:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**gui_focus_changed**\ (\ node\: :ref:`Control<class_Control>`\ ) :ref:`🔗<class_Viewport_signal_gui_focus_changed>`
|
||
|
||
Выдается, когда узел управления захватывает фокус клавиатуры.
|
||
|
||
\ **Примечание:** Потеря фокуса узлом управления не приводит к выдаче этого сигнала.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_signal_size_changed:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**size_changed**\ (\ ) :ref:`🔗<class_Viewport_signal_size_changed>`
|
||
|
||
Выдается при изменении размера области просмотра, будь то изменение размера окна или каким-либо другим способом.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Перечисления
|
||
------------------------
|
||
|
||
.. _enum_Viewport_PositionalShadowAtlasQuadrantSubdiv:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **PositionalShadowAtlasQuadrantSubdiv**: :ref:`🔗<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>`
|
||
|
||
.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED** = ``0``
|
||
|
||
Этот квадрант не будет использоваться.
|
||
|
||
.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_1:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **SHADOW_ATLAS_QUADRANT_SUBDIV_1** = ``1``
|
||
|
||
Этот квадрант будет использоваться только одной картой теней.
|
||
|
||
.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_4:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **SHADOW_ATLAS_QUADRANT_SUBDIV_4** = ``2``
|
||
|
||
Этот квадрант будет разделен на 4 части и использован для 4 карт теней.
|
||
|
||
.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_16:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **SHADOW_ATLAS_QUADRANT_SUBDIV_16** = ``3``
|
||
|
||
Этот квадрант будет разделен на 16 частей и будет использоваться для 16 карт теней.
|
||
|
||
.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_64:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **SHADOW_ATLAS_QUADRANT_SUBDIV_64** = ``4``
|
||
|
||
Этот квадрант будет разделен на 64 части и будет использоваться для 64 карт теней.
|
||
|
||
.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_256:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **SHADOW_ATLAS_QUADRANT_SUBDIV_256** = ``5``
|
||
|
||
Этот квадрант будет разделен на 256 частей и использован до 256 карт теней. Если :ref:`positional_shadow_atlas_size<class_Viewport_property_positional_shadow_atlas_size>` не очень высок, тени в этом квадранте будут иметь очень низкое разрешение.
|
||
|
||
.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_1024:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = ``6``
|
||
|
||
Этот квадрант будет разделен на 1024 части и использован до 1024 карт теней. Если :ref:`positional_shadow_atlas_size<class_Viewport_property_positional_shadow_atlas_size>` не очень высок, тени в этом квадранте будут иметь очень низкое разрешение.
|
||
|
||
.. _class_Viewport_constant_SHADOW_ATLAS_QUADRANT_SUBDIV_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = ``7``
|
||
|
||
Представляет размер перечисления :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_Scaling3DMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **Scaling3DMode**: :ref:`🔗<enum_Viewport_Scaling3DMode>`
|
||
|
||
.. _class_Viewport_constant_SCALING_3D_MODE_BILINEAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` **SCALING_3D_MODE_BILINEAR** = ``0``
|
||
|
||
Использовать билинейное масштабирование для 3D-буфера области просмотра. Величину масштабирования можно задать с помощью :ref:`scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Значения меньше ``1.0`` приведут к недостаточной выборке, а значения больше ``1.0`` приведут к избыточной выборке. Значение ``1.0`` отключает масштабирование.
|
||
|
||
.. _class_Viewport_constant_SCALING_3D_MODE_FSR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` **SCALING_3D_MODE_FSR** = ``1``
|
||
|
||
Используйте масштабирование AMD FidelityFX Super Resolution 1.0 для 3D-буфера области просмотра. Величину масштабирования можно задать с помощью :ref:`scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Значения меньше ``1.0`` приведут к масштабированию области просмотра с помощью FSR. Значения больше ``1.0`` не поддерживаются, и вместо этого будет использоваться билинейная понижающая дискретизация. Значение ``1.0`` отключает масштабирование.
|
||
|
||
.. _class_Viewport_constant_SCALING_3D_MODE_FSR2:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` **SCALING_3D_MODE_FSR2** = ``2``
|
||
|
||
Используйте масштабирование AMD FidelityFX Super Resolution 2.2 для 3D-буфера области просмотра. Величину масштабирования можно задать с помощью :ref:`scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Значения меньше ``1.0`` приведут к масштабированию области просмотра с использованием FSR2. Значения больше ``1.0`` не поддерживаются, и вместо этого будет использоваться билинейная понижающая дискретизация. Значение ``1.0`` будет использовать FSR2 при собственном разрешении в качестве решения TAA.
|
||
|
||
.. _class_Viewport_constant_SCALING_3D_MODE_METALFX_SPATIAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` **SCALING_3D_MODE_METALFX_SPATIAL** = ``3``
|
||
|
||
Используйте `MetalFX spatial upscaler <https://developer.apple.com/documentation/metalfx/mtlfxspatialscaler#overview>`__ для 3D-буфера области просмотра.
|
||
|
||
Величину масштабирования можно задать с помощью :ref:`scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`.
|
||
|
||
Значения меньше ``1.0`` приведут к масштабированию области просмотра с помощью MetalFX. Значения больше ``1.0`` не поддерживаются, и вместо них будет использоваться билинейная понижающая дискретизация. Значение ``1.0`` отключает масштабирование.
|
||
|
||
Дополнительная информация: `MetalFX <https://developer.apple.com/documentation/metalfx>`__.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании драйвера рендеринга Metal, что ограничивает этот режим масштабирования macOS и iOS.
|
||
|
||
.. _class_Viewport_constant_SCALING_3D_MODE_METALFX_TEMPORAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` **SCALING_3D_MODE_METALFX_TEMPORAL** = ``4``
|
||
|
||
Используйте `MetalFX temporal upscaler <https://developer.apple.com/documentation/metalfx/mtlfxtemporalscaler#overview>`__ для 3D-буфера области просмотра.
|
||
|
||
Величину масштабирования можно задать с помощью :ref:`scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Чтобы определить минимальный масштаб ввода, используйте метод :ref:`RenderingDevice.limit_get()<class_RenderingDevice_method_limit_get>` с :ref:`RenderingDevice.LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE<class_RenderingDevice_constant_LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE>`.
|
||
|
||
Значения меньше ``1.0`` приведут к масштабированию области просмотра с помощью MetalFX. Значения больше ``1.0`` не поддерживаются, и вместо этого будет использоваться билинейная понижающая дискретизация. Значение ``1.0`` будет использовать MetalFX в собственном разрешении в качестве решения TAA.
|
||
|
||
Дополнительная информация: `MetalFX <https://developer.apple.com/documentation/metalfx>`__.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании драйвера рендеринга Metal, что ограничивает этот режим масштабирования macOS и iOS.
|
||
|
||
.. _class_Viewport_constant_SCALING_3D_MODE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` **SCALING_3D_MODE_MAX** = ``5``
|
||
|
||
Представляет размер перечисления :ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_MSAA:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **MSAA**: :ref:`🔗<enum_Viewport_MSAA>`
|
||
|
||
.. _class_Viewport_constant_MSAA_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MSAA<enum_Viewport_MSAA>` **MSAA_DISABLED** = ``0``
|
||
|
||
Режим сглаживания Multisample отключен. Это значение по умолчанию, а также самая быстрая настройка.
|
||
|
||
.. _class_Viewport_constant_MSAA_2X:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MSAA<enum_Viewport_MSAA>` **MSAA_2X** = ``1``
|
||
|
||
Используйте 2× Multisample Antialiasing. Это имеет умеренные затраты производительности. Это помогает заметно уменьшить алиасинг, но 4× MSAA все равно выглядит значительно лучше.
|
||
|
||
.. _class_Viewport_constant_MSAA_4X:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MSAA<enum_Viewport_MSAA>` **MSAA_4X** = ``2``
|
||
|
||
Использовать 4× Multisample Antialiasing. Это значительно снижает производительность и, как правило, является хорошим компромиссом между производительностью и качеством.
|
||
|
||
.. _class_Viewport_constant_MSAA_8X:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MSAA<enum_Viewport_MSAA>` **MSAA_8X** = ``3``
|
||
|
||
Используйте 8× Multisample Antialiasing. Это очень дорого обходится производительности. Разница между 4× и 8× MSAA не всегда может быть видна в реальных игровых условиях. Вероятно, не поддерживается на слабом и старом оборудовании.
|
||
|
||
.. _class_Viewport_constant_MSAA_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MSAA<enum_Viewport_MSAA>` **MSAA_MAX** = ``4``
|
||
|
||
Представляет размер перечисления :ref:`MSAA<enum_Viewport_MSAA>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_AnisotropicFiltering:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AnisotropicFiltering**: :ref:`🔗<enum_Viewport_AnisotropicFiltering>`
|
||
|
||
.. _class_Viewport_constant_ANISOTROPY_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` **ANISOTROPY_DISABLED** = ``0``
|
||
|
||
Анизотропная фильтрация отключена.
|
||
|
||
.. _class_Viewport_constant_ANISOTROPY_2X:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` **ANISOTROPY_2X** = ``1``
|
||
|
||
Используйте 2-кратную анизотропную фильтрацию.
|
||
|
||
.. _class_Viewport_constant_ANISOTROPY_4X:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` **ANISOTROPY_4X** = ``2``
|
||
|
||
Использовать 4× анизотропную фильтрацию. Это значение по умолчанию.
|
||
|
||
.. _class_Viewport_constant_ANISOTROPY_8X:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` **ANISOTROPY_8X** = ``3``
|
||
|
||
Используйте 8-кратную анизотропную фильтрацию.
|
||
|
||
.. _class_Viewport_constant_ANISOTROPY_16X:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` **ANISOTROPY_16X** = ``4``
|
||
|
||
Используйте 16-кратную анизотропную фильтрацию.
|
||
|
||
.. _class_Viewport_constant_ANISOTROPY_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` **ANISOTROPY_MAX** = ``5``
|
||
|
||
Представляет размер перечисления :ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_ScreenSpaceAA:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **ScreenSpaceAA**: :ref:`🔗<enum_Viewport_ScreenSpaceAA>`
|
||
|
||
.. _class_Viewport_constant_SCREEN_SPACE_AA_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>` **SCREEN_SPACE_AA_DISABLED** = ``0``
|
||
|
||
Не выполняйте сглаживание при полноэкранной постобработке.
|
||
|
||
.. _class_Viewport_constant_SCREEN_SPACE_AA_FXAA:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>` **SCREEN_SPACE_AA_FXAA** = ``1``
|
||
|
||
Использует быстрое приблизительное сглаживание. FXAA — популярный метод сглаживания в экранном пространстве, который быстр, но делает изображение размытым, особенно при низком разрешении. Он может работать относительно хорошо при больших разрешениях, таких как 1440p и 4K.
|
||
|
||
.. _class_Viewport_constant_SCREEN_SPACE_AA_SMAA:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>` **SCREEN_SPACE_AA_SMAA** = ``2``
|
||
|
||
Использовать субпиксельное морфологическое сглаживание (SMAA). SMAA может давать более чёткие результаты, чем FXAA, но требует несколько больших затрат производительности.
|
||
|
||
.. _class_Viewport_constant_SCREEN_SPACE_AA_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>` **SCREEN_SPACE_AA_MAX** = ``3``
|
||
|
||
Представляет размер перечисления :ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_RenderInfo:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **RenderInfo**: :ref:`🔗<enum_Viewport_RenderInfo>`
|
||
|
||
.. _class_Viewport_constant_RENDER_INFO_OBJECTS_IN_FRAME:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`RenderInfo<enum_Viewport_RenderInfo>` **RENDER_INFO_OBJECTS_IN_FRAME** = ``0``
|
||
|
||
Количество объектов в кадре.
|
||
|
||
.. _class_Viewport_constant_RENDER_INFO_PRIMITIVES_IN_FRAME:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`RenderInfo<enum_Viewport_RenderInfo>` **RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1``
|
||
|
||
Количество вершин в кадре.
|
||
|
||
.. _class_Viewport_constant_RENDER_INFO_DRAW_CALLS_IN_FRAME:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`RenderInfo<enum_Viewport_RenderInfo>` **RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2``
|
||
|
||
Количество вызовов отрисовки в кадре.
|
||
|
||
.. _class_Viewport_constant_RENDER_INFO_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`RenderInfo<enum_Viewport_RenderInfo>` **RENDER_INFO_MAX** = ``3``
|
||
|
||
Представляет размер перечисления :ref:`RenderInfo<enum_Viewport_RenderInfo>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_RenderInfoType:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **RenderInfoType**: :ref:`🔗<enum_Viewport_RenderInfoType>`
|
||
|
||
.. _class_Viewport_constant_RENDER_INFO_TYPE_VISIBLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`RenderInfoType<enum_Viewport_RenderInfoType>` **RENDER_INFO_TYPE_VISIBLE** = ``0``
|
||
|
||
Видимый проход рендеринга (без теней).
|
||
|
||
.. _class_Viewport_constant_RENDER_INFO_TYPE_SHADOW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`RenderInfoType<enum_Viewport_RenderInfoType>` **RENDER_INFO_TYPE_SHADOW** = ``1``
|
||
|
||
Проход рендеринга теней. Объекты будут рендериться несколько раз в зависимости от количества источников света с тенями и количества направленных теневых разделений.
|
||
|
||
.. _class_Viewport_constant_RENDER_INFO_TYPE_CANVAS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`RenderInfoType<enum_Viewport_RenderInfoType>` **RENDER_INFO_TYPE_CANVAS** = ``2``
|
||
|
||
Рендеринг элемента Canvas (холст). Сюда входит весь 2D-рендеринг.
|
||
|
||
.. _class_Viewport_constant_RENDER_INFO_TYPE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`RenderInfoType<enum_Viewport_RenderInfoType>` **RENDER_INFO_TYPE_MAX** = ``3``
|
||
|
||
Представляет размер перечисления :ref:`RenderInfoType<enum_Viewport_RenderInfoType>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_DebugDraw:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **DebugDraw**: :ref:`🔗<enum_Viewport_DebugDraw>`
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_DISABLED** = ``0``
|
||
|
||
Объекты отображаются нормально.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_UNSHADED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_UNSHADED** = ``1``
|
||
|
||
Объекты отображаются без световой информации.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_LIGHTING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_LIGHTING** = ``2``
|
||
|
||
Объекты отображаются без текстур и только с информацией об освещении.
|
||
|
||
\ **Примечание:** При использовании этого режима отладки рисования, пользовательские шейдеры игнорируются, поскольку все материалы в сцене временно используют отладочный материал. Это означает, что результат функций пользовательских шейдеров (например, смещение вершин) больше не будет виден при использовании этого режима отладки рисования.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_OVERDRAW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_OVERDRAW** = ``3``
|
||
|
||
Объекты отображаются полупрозрачными с аддитивным смешиванием, так что вы можете видеть, где они рисуются друг над другом. Более высокая перерисовка означает, что вы тратите производительность на рисование пикселей, которые скрыты за другими.
|
||
|
||
\ **Примечание:** При использовании этого режима отладки отрисовки, пользовательские шейдеры игнорируются, поскольку все материалы в сцене временно используют отладочный материал. Это означает, что результат функций пользовательских шейдеров (например, смещение вершин) больше не будет виден при использовании этого режима отладки отрисовки.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_WIREFRAME:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_WIREFRAME** = ``4``
|
||
|
||
Объекты отображаются как каркасные модели.
|
||
|
||
\ **Примечание:** :ref:`RenderingServer.set_debug_generate_wireframes()<class_RenderingServer_method_set_debug_generate_wireframes>` необходимо вызывать перед загрузкой любых сеток, чтобы каркасы были видны при использовании рендерера совместимости.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_NORMAL_BUFFER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_NORMAL_BUFFER** = ``5``
|
||
|
||
Объекты отображаются без информации об освещении, а их текстуры заменяются обычным отображением.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_VOXEL_GI_ALBEDO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6``
|
||
|
||
Объекты отображаются только со значением альбедо из :ref:`VoxelGI<class_VoxelGI>`. Требуется как минимум один видимый узел :ref:`VoxelGI<class_VoxelGI>`, который был запечен для получения видимого эффекта.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_VOXEL_GI_LIGHTING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7``
|
||
|
||
Объекты отображаются только со значением освещения из :ref:`VoxelGI<class_VoxelGI>`. Требуется как минимум один видимый узел :ref:`VoxelGI<class_VoxelGI>`, который был запечен для получения видимого эффекта.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_VOXEL_GI_EMISSION:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8``
|
||
|
||
Объекты отображаются только с цветом излучения (emission) от :ref:`VoxelGI<class_VoxelGI>`. Требуется как минимум один видимый узел :ref:`VoxelGI<class_VoxelGI>`, который был запечен для получения видимого эффекта.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_SHADOW_ATLAS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_SHADOW_ATLAS** = ``9``
|
||
|
||
Рисует атлас теней, в котором хранятся тени от :ref:`OmniLight3D<class_OmniLight3D>`-ов и :ref:`SpotLight3D<class_SpotLight3D>`-ов в верхнем левом квадранте **Viewport**.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10``
|
||
|
||
Рисует атлас теней, в котором хранятся тени от :ref:`DirectionalLight3D<class_DirectionalLight3D>` в верхнем левом квадранте **Viewport**.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_SCENE_LUMINANCE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_SCENE_LUMINANCE** = ``11``
|
||
|
||
Рисует буфер яркости сцены (если доступен) в верхнем левом квадранте **Viewport**.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании методов рендеринга Forward+ или Mobile.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_SSAO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_SSAO** = ``12``
|
||
|
||
Рисует текстуру экранного пространства Ambient Occlusion вместо сцены, чтобы вы могли четко видеть, как она влияет на объекты. Чтобы этот режим отображения работал, необходимо установить :ref:`Environment.ssao_enabled<class_Environment_property_ssao_enabled>` в вашем :ref:`WorldEnvironment<class_WorldEnvironment>`.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_SSIL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_SSIL** = ``13``
|
||
|
||
Рисует текстуру непрямого освещения экранного пространства вместо сцены, чтобы вы могли четко видеть, как она влияет на объекты. Чтобы этот режим отображения работал, необходимо установить :ref:`Environment.ssil_enabled<class_Environment_property_ssil_enabled>` в :ref:`WorldEnvironment<class_WorldEnvironment>`.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_PSSM_SPLITS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_PSSM_SPLITS** = ``14``
|
||
|
||
Окрашивает каждое разделение PSSM для :ref:`DirectionalLight3D<class_DirectionalLight3D>` в сцене в другой цвет, чтобы вы могли видеть, где находятся разделения. По порядку (от самого близкого к самому дальнему от камеры) они окрашены в красный, зеленый, синий и желтый цвет.
|
||
|
||
\ **Примечание:** При использовании этого режима отладки отрисовки, пользовательские шейдеры игнорируются, поскольку все материалы в сцене временно используют отладочный материал. Это означает, что результат функций пользовательских шейдеров (например, смещение вершин) больше не будет виден при использовании этого режима отладки отрисовки.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании методов рендеринга Forward+ или Mobile.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_DECAL_ATLAS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_DECAL_ATLAS** = ``15``
|
||
|
||
Рисует атлас декалей, используемый :ref:`Decal<class_Decal>`-ями и текстурами проектора света в верхнем левом квадранте **Viewport**.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании методов рендеринга Forward+ или Mobile.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_SDFGI:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_SDFGI** = ``16``
|
||
|
||
Рисует каскады, используемые для визуализации глобального освещения поля расстояний со знаком (SDFGI).
|
||
|
||
Ничего не делает, если :ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>` текущей среды имеет значение ``false``.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода визуализации Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_SDFGI_PROBES:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_SDFGI_PROBES** = ``17``
|
||
|
||
Draws the probes used for signed distance field global illumination (SDFGI).
|
||
|
||
When in the editor, left-clicking a probe will display additional bright dots that show its occlusion information. A white dot means the light is not occluded at all at the dot's position, while a red dot means the light is fully occluded. Intermediate values are possible.
|
||
|
||
Does nothing if the current environment's :ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>` is ``false``.
|
||
|
||
\ **Note:** Only supported when using the Forward+ rendering method.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_GI_BUFFER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_GI_BUFFER** = ``18``
|
||
|
||
Рисует буфер, используемый для глобального освещения из :ref:`VoxelGI<class_VoxelGI>` или SDFGI. Требует включения :ref:`VoxelGI<class_VoxelGI>` (по крайней мере одного видимого запеченного узла VoxelGI) или SDFGI (:ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>`) для видимого эффекта.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_DISABLE_LOD:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_DISABLE_LOD** = ``19``
|
||
|
||
Рисует все объекты с наивысшим полигоном независимо от их расстояния от камеры. Низкий уровень детализации (LOD) не применяется.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20``
|
||
|
||
Рисует кластер, используемый узлами :ref:`OmniLight3D<class_OmniLight3D>` для оптимизации рендеринга света.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21``
|
||
|
||
Рисует кластер, используемый узлами :ref:`SpotLight3D<class_SpotLight3D>` для оптимизации рендеринга света.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_CLUSTER_DECALS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_CLUSTER_DECALS** = ``22``
|
||
|
||
Рисует кластер, используемый узлами :ref:`Decal<class_Decal>` для оптимизации рендеринга декалей.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23``
|
||
|
||
Рисует кластер, используемый узлами :ref:`ReflectionProbe<class_ReflectionProbe>` для оптимизации зондов отражения.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_OCCLUDERS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_OCCLUDERS** = ``24``
|
||
|
||
Рисует буфер, используемый для отбраковки окклюзии (occlusion culling).
|
||
|
||
\ **Примечание:** Поддерживается только при использовании методов рендеринга Forward+ или Mobile.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_MOTION_VECTORS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_MOTION_VECTORS** = ``25``
|
||
|
||
Рисует векторные линии на области просмотра, чтобы обозначить движение пикселей между кадрами.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании метода рендеринга Forward+.
|
||
|
||
.. _class_Viewport_constant_DEBUG_DRAW_INTERNAL_BUFFER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **DEBUG_DRAW_INTERNAL_BUFFER** = ``26``
|
||
|
||
Рисует внутренний буфер разрешения сцены в линейном цветовом пространстве перед применением тональной компрессии или постобработки.
|
||
|
||
\ **Примечание:** Поддерживается только при использовании методов рендеринга Forward+ или Mobile.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_DefaultCanvasItemTextureFilter:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **DefaultCanvasItemTextureFilter**: :ref:`🔗<enum_Viewport_DefaultCanvasItemTextureFilter>`
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``0``
|
||
|
||
Фильтр текстуры считывает только ближайший пиксель. Это делает текстуру пикселизированной вблизи и зернистой на расстоянии (из-за того, что mip-карты не сэмплируются).
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``1``
|
||
|
||
Фильтр текстуры смешивает ближайшие 4 пикселя. Это делает текстуру гладкой вблизи и зернистой на расстоянии (из-за того, что mip-карты не сэмплируются).
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``2``
|
||
|
||
Фильтр текстуры смешивает ближайшие 4 пикселя и ближайшие 2 mip-карты (или использует ближайшую mip-карту, если :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` имеет значение ``true``). Это делает текстуру гладкой вблизи и гладкой на расстоянии.
|
||
|
||
Используйте это для текстур непиксельной графики, которые можно просматривать в низком масштабе (например, из-за масштабирования :ref:`Camera2D<class_Camera2D>` или масштабирования спрайтов), поскольку mip-карты важны для сглаживания пикселей, которые меньше пикселей на экране.
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
|
||
|
||
Фильтр текстуры считывает данные с ближайшего пикселя и смешивает данные между двумя ближайшими mip-картами (или использует ближайшую mip-карту, если :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` имеет значение ``true``). Это делает текстуру пикселизированной вблизи и гладкой на расстоянии.
|
||
|
||
Используйте это для текстур, не являющихся пиксельным искусством, которые можно просматривать в низком масштабе (например, из-за масштабирования :ref:`Camera2D<class_Camera2D>` или масштабирования спрайтов), поскольку mip-карты важны для сглаживания пикселей, которые меньше пикселей на экране.
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``4``
|
||
|
||
Представляет размер перечисления :ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_DefaultCanvasItemTextureRepeat:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **DefaultCanvasItemTextureRepeat**: :ref:`🔗<enum_Viewport_DefaultCanvasItemTextureRepeat>`
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>` **DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = ``0``
|
||
|
||
Отключает повторение текстур. Вместо этого при считывании UV за пределами диапазона 0-1 значение будет прижато к краю текстуры, что приведет к растянутому виду границ текстуры.
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>` **DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = ``1``
|
||
|
||
Позволяет текстуре повторяться, когда координаты UV выходят за пределы диапазона 0-1. При использовании одного из режимов линейной фильтрации это может привести к появлению артефактов на краях текстуры, когда сэмплер фильтрует края текстуры.
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>` **DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``2``
|
||
|
||
При повторении переворачивайте текстуру так, чтобы края совпадали, а не резко менялись.
|
||
|
||
.. _class_Viewport_constant_DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>` **DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``3``
|
||
|
||
Представляет размер перечисления :ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_SDFOversize:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **SDFOversize**: :ref:`🔗<enum_Viewport_SDFOversize>`
|
||
|
||
.. _class_Viewport_constant_SDF_OVERSIZE_100_PERCENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFOversize<enum_Viewport_SDFOversize>` **SDF_OVERSIZE_100_PERCENT** = ``0``
|
||
|
||
Поле расстояния со знаком охватывает только собственный прямоугольник области просмотра.
|
||
|
||
.. _class_Viewport_constant_SDF_OVERSIZE_120_PERCENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFOversize<enum_Viewport_SDFOversize>` **SDF_OVERSIZE_120_PERCENT** = ``1``
|
||
|
||
Поле расстояния со знаком расширяется, охватывая 20% размера области просмотра вокруг границ.
|
||
|
||
.. _class_Viewport_constant_SDF_OVERSIZE_150_PERCENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFOversize<enum_Viewport_SDFOversize>` **SDF_OVERSIZE_150_PERCENT** = ``2``
|
||
|
||
Поле расстояния со знаком расширяется, охватывая 50% размера области просмотра вокруг границ.
|
||
|
||
.. _class_Viewport_constant_SDF_OVERSIZE_200_PERCENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFOversize<enum_Viewport_SDFOversize>` **SDF_OVERSIZE_200_PERCENT** = ``3``
|
||
|
||
Поле расстояния со знаком расширяется, охватывая 100% (в два раза) размера области просмотра вокруг границ.
|
||
|
||
.. _class_Viewport_constant_SDF_OVERSIZE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFOversize<enum_Viewport_SDFOversize>` **SDF_OVERSIZE_MAX** = ``4``
|
||
|
||
Представляет размер перечисления :ref:`SDFOversize<enum_Viewport_SDFOversize>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_SDFScale:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **SDFScale**: :ref:`🔗<enum_Viewport_SDFScale>`
|
||
|
||
.. _class_Viewport_constant_SDF_SCALE_100_PERCENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFScale<enum_Viewport_SDFScale>` **SDF_SCALE_100_PERCENT** = ``0``
|
||
|
||
Поле знакового расстояния отображается в полном разрешении.
|
||
|
||
.. _class_Viewport_constant_SDF_SCALE_50_PERCENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFScale<enum_Viewport_SDFScale>` **SDF_SCALE_50_PERCENT** = ``1``
|
||
|
||
Поле знакового расстояния отображается с разрешением, равным половине разрешения этой области просмотра.
|
||
|
||
.. _class_Viewport_constant_SDF_SCALE_25_PERCENT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFScale<enum_Viewport_SDFScale>` **SDF_SCALE_25_PERCENT** = ``2``
|
||
|
||
Поле знакового расстояния отображается с разрешением, равным четверти разрешения этой области просмотра.
|
||
|
||
.. _class_Viewport_constant_SDF_SCALE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SDFScale<enum_Viewport_SDFScale>` **SDF_SCALE_MAX** = ``3``
|
||
|
||
Представляет размер перечисления :ref:`SDFScale<enum_Viewport_SDFScale>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_VRSMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **VRSMode**: :ref:`🔗<enum_Viewport_VRSMode>`
|
||
|
||
.. _class_Viewport_constant_VRS_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VRSMode<enum_Viewport_VRSMode>` **VRS_DISABLED** = ``0``
|
||
|
||
Функция затенения с переменной скоростью (VRS) отключена.
|
||
|
||
.. _class_Viewport_constant_VRS_TEXTURE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VRSMode<enum_Viewport_VRSMode>` **VRS_TEXTURE** = ``1``
|
||
|
||
Variable Rate Shading использует текстуру. Обратите внимание, для стереоскопического используйте атлас текстур с текстурой для каждого вида.
|
||
|
||
.. _class_Viewport_constant_VRS_XR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VRSMode<enum_Viewport_VRSMode>` **VRS_XR** = ``2``
|
||
|
||
Текстура Variable Rate Shading предоставляется первичным :ref:`XRInterface<class_XRInterface>`.
|
||
|
||
.. _class_Viewport_constant_VRS_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VRSMode<enum_Viewport_VRSMode>` **VRS_MAX** = ``3``
|
||
|
||
Представляет размер перечисления :ref:`VRSMode<enum_Viewport_VRSMode>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_Viewport_VRSUpdateMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **VRSUpdateMode**: :ref:`🔗<enum_Viewport_VRSUpdateMode>`
|
||
|
||
.. _class_Viewport_constant_VRS_UPDATE_DISABLED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>` **VRS_UPDATE_DISABLED** = ``0``
|
||
|
||
Входная текстура для затенения с переменной скоростью не будет обработана.
|
||
|
||
.. _class_Viewport_constant_VRS_UPDATE_ONCE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>` **VRS_UPDATE_ONCE** = ``1``
|
||
|
||
Входная текстура для затенения с переменной скоростью будет обработана один раз.
|
||
|
||
.. _class_Viewport_constant_VRS_UPDATE_ALWAYS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>` **VRS_UPDATE_ALWAYS** = ``2``
|
||
|
||
Входная текстура для затенения с переменной скоростью будет обрабатываться в каждом кадре.
|
||
|
||
.. _class_Viewport_constant_VRS_UPDATE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>` **VRS_UPDATE_MAX** = ``3``
|
||
|
||
Представляет размер перечисления :ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>`.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описания свойств
|
||
--------------------------------
|
||
|
||
.. _class_Viewport_property_anisotropic_filtering_level:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` **anisotropic_filtering_level** = ``2`` :ref:`🔗<class_Viewport_property_anisotropic_filtering_level>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_anisotropic_filtering_level**\ (\ value\: :ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>`\ )
|
||
- :ref:`AnisotropicFiltering<enum_Viewport_AnisotropicFiltering>` **get_anisotropic_filtering_level**\ (\ )
|
||
|
||
Устанавливает максимальное количество выборок при использовании анизотропной фильтрации текстур (как степень двойки). Большее количество выборок приведет к более резким текстурам под косыми углами, но это более затратно для вычисления. Значение ``0`` принудительно отключает анизотропную фильтрацию, даже для материалов, где она включена.
|
||
|
||
Уровень анизотропной фильтрации также влияет на декали и проекторы света, если они настроены на использование анизотропной фильтрации. См. :ref:`ProjectSettings.rendering/textures/decals/filter<class_ProjectSettings_property_rendering/textures/decals/filter>` и :ref:`ProjectSettings.rendering/textures/light_projectors/filter<class_ProjectSettings_property_rendering/textures/light_projectors/filter>`.
|
||
|
||
\ **Примечание:** В 3D, чтобы эта настройка имела эффект, установите :ref:`BaseMaterial3D.texture_filter<class_BaseMaterial3D_property_texture_filter>` на :ref:`BaseMaterial3D.TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC<class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC>` или :ref:`BaseMaterial3D.TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC<class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC>` для материалов.
|
||
|
||
\ **Примечание:** В 2D, чтобы эта настройка имела эффект, установите :ref:`CanvasItem.texture_filter<class_CanvasItem_property_texture_filter>` на :ref:`CanvasItem.TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC<class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC>` или :ref:`CanvasItem.TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC<class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC>` на узле :ref:`CanvasItem<class_CanvasItem>`, отображающем текстуру (или в :ref:`CanvasTexture<class_CanvasTexture>`). Однако анизотропная фильтрация редко бывает полезна в 2D, поэтому включайте ее для текстур в 2D только в том случае, если это создает значимую визуальную разницу.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_audio_listener_enable_2d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **audio_listener_enable_2d** = ``false`` :ref:`🔗<class_Viewport_property_audio_listener_enable_2d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_as_audio_listener_2d**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_audio_listener_2d**\ (\ )
|
||
|
||
Если ``true``, область просмотра будет обрабатывать 2D-аудиопотоки.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_audio_listener_enable_3d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **audio_listener_enable_3d** = ``false`` :ref:`🔗<class_Viewport_property_audio_listener_enable_3d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_as_audio_listener_3d**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_audio_listener_3d**\ (\ )
|
||
|
||
Если ``true``, область просмотра будет обрабатывать 3D-аудиопотоки.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_canvas_cull_mask:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **canvas_cull_mask** = ``4294967295`` :ref:`🔗<class_Viewport_property_canvas_cull_mask>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_canvas_cull_mask**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_canvas_cull_mask**\ (\ )
|
||
|
||
The rendering layers in which this **Viewport** renders :ref:`CanvasItem<class_CanvasItem>` nodes.
|
||
|
||
\ **Note:** A :ref:`CanvasItem<class_CanvasItem>` does not inherit its parents' visibility layers. See :ref:`CanvasItem.visibility_layer<class_CanvasItem_property_visibility_layer>`'s description for details.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_canvas_item_default_texture_filter:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **canvas_item_default_texture_filter** = ``1`` :ref:`🔗<class_Viewport_property_canvas_item_default_texture_filter>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_default_canvas_item_texture_filter**\ (\ value\: :ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>`\ )
|
||
- :ref:`DefaultCanvasItemTextureFilter<enum_Viewport_DefaultCanvasItemTextureFilter>` **get_default_canvas_item_texture_filter**\ (\ )
|
||
|
||
The default filter mode used by :ref:`CanvasItem<class_CanvasItem>` nodes in this viewport.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_canvas_item_default_texture_repeat:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>` **canvas_item_default_texture_repeat** = ``0`` :ref:`🔗<class_Viewport_property_canvas_item_default_texture_repeat>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_default_canvas_item_texture_repeat**\ (\ value\: :ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>`\ )
|
||
- :ref:`DefaultCanvasItemTextureRepeat<enum_Viewport_DefaultCanvasItemTextureRepeat>` **get_default_canvas_item_texture_repeat**\ (\ )
|
||
|
||
The default repeat mode used by :ref:`CanvasItem<class_CanvasItem>` nodes in this viewport.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_canvas_transform:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Transform2D<class_Transform2D>` **canvas_transform** :ref:`🔗<class_Viewport_property_canvas_transform>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_canvas_transform**\ (\ value\: :ref:`Transform2D<class_Transform2D>`\ )
|
||
- :ref:`Transform2D<class_Transform2D>` **get_canvas_transform**\ (\ )
|
||
|
||
Преобразование холста вьюпорта, полезное для изменения положения на экране всех дочерних :ref:`CanvasItem<class_CanvasItem>`. Это относительно глобального преобразования холста вьюпорта.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_debug_draw:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`DebugDraw<enum_Viewport_DebugDraw>` **debug_draw** = ``0`` :ref:`🔗<class_Viewport_property_debug_draw>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_debug_draw**\ (\ value\: :ref:`DebugDraw<enum_Viewport_DebugDraw>`\ )
|
||
- :ref:`DebugDraw<enum_Viewport_DebugDraw>` **get_debug_draw**\ (\ )
|
||
|
||
Режим наложения для тестирования визуализированной геометрии в целях отладки.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_disable_3d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **disable_3d** = ``false`` :ref:`🔗<class_Viewport_property_disable_3d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_disable_3d**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_3d_disabled**\ (\ )
|
||
|
||
Отключить 3D-рендеринг (но сохранить 2D-рендеринг).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_fsr_sharpness:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **fsr_sharpness** = ``0.2`` :ref:`🔗<class_Viewport_property_fsr_sharpness>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_fsr_sharpness**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_fsr_sharpness**\ (\ )
|
||
|
||
Определяет, насколько резким будет увеличенное изображение при использовании режима увеличения FSR. Резкость уменьшается вдвое с каждым целым числом. Значения варьируются от 0,0 (максимальная резкость) до 2,0. Значения выше 2,0 не будут иметь видимого значения.
|
||
|
||
Чтобы управлять этим свойством в корневом окне просмотра, задайте настройку проекта :ref:`ProjectSettings.rendering/scaling_3d/fsr_sharpness<class_ProjectSettings_property_rendering/scaling_3d/fsr_sharpness>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_global_canvas_transform:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Transform2D<class_Transform2D>` **global_canvas_transform** :ref:`🔗<class_Viewport_property_global_canvas_transform>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_global_canvas_transform**\ (\ value\: :ref:`Transform2D<class_Transform2D>`\ )
|
||
- :ref:`Transform2D<class_Transform2D>` **get_global_canvas_transform**\ (\ )
|
||
|
||
Глобальное преобразование холста вьюпорта. Преобразование холста относительно этого.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_gui_disable_input:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **gui_disable_input** = ``false`` :ref:`🔗<class_Viewport_property_gui_disable_input>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_disable_input**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_input_disabled**\ (\ )
|
||
|
||
Если ``true``, область просмотра не будет получать входные (Input) события.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_gui_drag_threshold:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **gui_drag_threshold** = ``10`` :ref:`🔗<class_Viewport_property_gui_drag_threshold>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_drag_threshold**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_drag_threshold**\ (\ )
|
||
|
||
The minimum distance the mouse cursor must move while pressed before a drag operation begins.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_gui_embed_subwindows:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **gui_embed_subwindows** = ``false`` :ref:`🔗<class_Viewport_property_gui_embed_subwindows>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_embedding_subwindows**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_embedding_subwindows**\ (\ )
|
||
|
||
Если ``true``, подокна (всплывающие окна и диалоги) будут встроены в окно приложения как узлы, подобные элементам управления. Если ``false``, они будут отображаться как отдельные окна, управляемые операционной системой.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_gui_snap_controls_to_pixels:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **gui_snap_controls_to_pixels** = ``true`` :ref:`🔗<class_Viewport_property_gui_snap_controls_to_pixels>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_snap_controls_to_pixels**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_snap_controls_to_pixels_enabled**\ (\ )
|
||
|
||
Если ``true``, элементы управления графическим интерфейсом в области просмотра будут располагаться идеально по пикселям.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_handle_input_locally:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **handle_input_locally** = ``true`` :ref:`🔗<class_Viewport_property_handle_input_locally>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_handle_input_locally**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_handling_input_locally**\ (\ )
|
||
|
||
Если ``true``, эта область просмотра будет отмечать входящие события ввода как обработанные ею самой. Если ``false``, это будет сделано первой родительской областью просмотра, которая настроена на локальную обработку ввода.
|
||
|
||
\ :ref:`SubViewportContainer<class_SubViewportContainer>` автоматически установит это свойство в ``false`` для **Viewport**, содержащегося внутри него.
|
||
|
||
См. также :ref:`set_input_as_handled()<class_Viewport_method_set_input_as_handled>` и :ref:`is_input_handled()<class_Viewport_method_is_input_handled>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_mesh_lod_threshold:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **mesh_lod_threshold** = ``1.0`` :ref:`🔗<class_Viewport_property_mesh_lod_threshold>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_mesh_lod_threshold**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_mesh_lod_threshold**\ (\ )
|
||
|
||
Автоматическое смещение LOD для использования сеток, визуализируемых в **Viewport** (аналогично :ref:`ReflectionProbe.mesh_lod_threshold<class_ReflectionProbe_property_mesh_lod_threshold>`). Более высокие значения будут использовать менее подробные версии сеток, которые имеют сгенерированные вариации LOD. Если установлено значение ``0.0``, автоматический LOD отключен. Увеличьте :ref:`mesh_lod_threshold<class_Viewport_property_mesh_lod_threshold>`, чтобы повысить производительность за счет детализации геометрии.
|
||
|
||
Чтобы управлять этим свойством в корневом viewport, задайте настройку проекта :ref:`ProjectSettings.rendering/mesh_lod/lod_change/threshold_pixels<class_ProjectSettings_property_rendering/mesh_lod/lod_change/threshold_pixels>`.
|
||
|
||
\ **Примечание:** :ref:`mesh_lod_threshold<class_Viewport_property_mesh_lod_threshold>` не влияет на диапазоны видимости :ref:`GeometryInstance3D<class_GeometryInstance3D>` (также известные как «ручной» LOD или иерархический LOD).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_msaa_2d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`MSAA<enum_Viewport_MSAA>` **msaa_2d** = ``0`` :ref:`🔗<class_Viewport_property_msaa_2d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_msaa_2d**\ (\ value\: :ref:`MSAA<enum_Viewport_MSAA>`\ )
|
||
- :ref:`MSAA<enum_Viewport_MSAA>` **get_msaa_2d**\ (\ )
|
||
|
||
Режим сглаживания с несколькими выборками для рендеринга 2D/Canvas. Более высокое число приводит к более гладким краям за счет значительного ухудшения производительности. Значение :ref:`MSAA_2X<class_Viewport_constant_MSAA_2X>` или :ref:`MSAA_4X<class_Viewport_constant_MSAA_4X>` является наилучшим, если только вы не нацелены на очень высокопроизводительные системы. Это не влияет на сглаживание, вызванное шейдером, или сглаживание текстур.
|
||
|
||
См. также :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_2d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_2d>` и :ref:`RenderingServer.viewport_set_msaa_2d()<class_RenderingServer_method_viewport_set_msaa_2d>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_msaa_3d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`MSAA<enum_Viewport_MSAA>` **msaa_3d** = ``0`` :ref:`🔗<class_Viewport_property_msaa_3d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_msaa_3d**\ (\ value\: :ref:`MSAA<enum_Viewport_MSAA>`\ )
|
||
- :ref:`MSAA<enum_Viewport_MSAA>` **get_msaa_3d**\ (\ )
|
||
|
||
Режим сглаживания мультисэмпла для 3D-рендеринга. Более высокое число приводит к более гладким краям за счет значительного ухудшения производительности. Значение :ref:`MSAA_2X<class_Viewport_constant_MSAA_2X>` или :ref:`MSAA_4X<class_Viewport_constant_MSAA_4X>` является лучшим, если только вы не нацелены на очень высокопроизводительные системы. См. также билинейное масштабирование 3D :ref:`scaling_3d_mode<class_Viewport_property_scaling_3d_mode>` для суперсэмплинга, которое обеспечивает более высокое качество, но гораздо более затратно. Это не влияет на сглаживание, вызванное шейдером, или сглаживание текстур.
|
||
|
||
См. также :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_3d>` и :ref:`RenderingServer.viewport_set_msaa_3d()<class_RenderingServer_method_viewport_set_msaa_3d>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_oversampling:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **oversampling** = ``true`` :ref:`🔗<class_Viewport_property_oversampling>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_use_oversampling**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_using_oversampling**\ (\ )
|
||
|
||
Если ``true`` и выполняется одно из следующих условий: установлены :ref:`SubViewport.size_2d_override_stretch<class_SubViewport_property_size_2d_override_stretch>` и :ref:`SubViewport.size_2d_override<class_SubViewport_property_size_2d_override>`, установлен :ref:`Window.content_scale_factor<class_Window_property_content_scale_factor>` и включено масштабирование, установлен :ref:`oversampling_override<class_Viewport_property_oversampling_override>`, включены передискретизация шрифта и :ref:`DPITexture<class_DPITexture>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_oversampling_override:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **oversampling_override** = ``0.0`` :ref:`🔗<class_Viewport_property_oversampling_override>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_oversampling_override**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_oversampling_override**\ (\ )
|
||
|
||
Если значение больше нуля, это значение используется как коэффициент передискретизации шрифта, в противном случае передискретизация равна масштабу области просмотра.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_own_world_3d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **own_world_3d** = ``false`` :ref:`🔗<class_Viewport_property_own_world_3d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_use_own_world_3d**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_using_own_world_3d**\ (\ )
|
||
|
||
Если ``true``, область просмотра будет использовать уникальную копию :ref:`World3D<class_World3D>`, определенную в :ref:`world_3d<class_Viewport_property_world_3d>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_physics_object_picking:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **physics_object_picking** = ``false`` :ref:`🔗<class_Viewport_property_physics_object_picking>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_physics_object_picking**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_physics_object_picking**\ (\ )
|
||
|
||
Если ``true``, объекты, отображаемые областью просмотра, становятся предметами процесса выбора мышью.
|
||
|
||
\ **Примечание:** Количество одновременно выбираемых объектов ограничено 64, и они выбираются в неопределенном порядке, который может быть разным в каждом процессе выбора.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_physics_object_picking_first_only:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **physics_object_picking_first_only** = ``false`` :ref:`🔗<class_Viewport_property_physics_object_picking_first_only>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_physics_object_picking_first_only**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_physics_object_picking_first_only**\ (\ )
|
||
|
||
Если ``true``, сигнал input_event будет отправлен только одному физическому объекту в процессе выбора мыши. Если вы хотите получить только верхний объект, вы также должны включить :ref:`physics_object_picking_sort<class_Viewport_property_physics_object_picking_sort>`.
|
||
|
||
Если ``false``, сигнал input_event будет отправлен всем физическим объектам в процессе выбора мыши.
|
||
|
||
Это применимо только к выбору объекта 2D CanvasItem.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_physics_object_picking_sort:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **physics_object_picking_sort** = ``false`` :ref:`🔗<class_Viewport_property_physics_object_picking_sort>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_physics_object_picking_sort**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_physics_object_picking_sort**\ (\ )
|
||
|
||
Если ``true``, объекты получают события выбора мыши, отсортированные в первую очередь по их :ref:`CanvasItem.z_index<class_CanvasItem_property_z_index>` и во вторую очередь по их положению в дереве сцены. Если ``false``, порядок не определен.
|
||
|
||
\ **Примечание:** Этот параметр отключен по умолчанию из-за его потенциально дорогостоящих вычислительных затрат.
|
||
|
||
\ **Примечание:** Сортировка происходит после выбора выбираемых объектов. Из-за ограничения в 64 одновременно выбираемых объекта не гарантируется, что объект с наивысшим :ref:`CanvasItem.z_index<class_CanvasItem_property_z_index>` получит событие выбора.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_positional_shadow_atlas_16_bits:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **positional_shadow_atlas_16_bits** = ``true`` :ref:`🔗<class_Viewport_property_positional_shadow_atlas_16_bits>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_positional_shadow_atlas_16_bits**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_positional_shadow_atlas_16_bits**\ (\ )
|
||
|
||
Используйте 16 бит для карты глубины тени omni/spot. Включение этого параметра приводит к снижению точности теней и может привести к появлению акне в тенях, но может привести к повышению производительности на некоторых устройствах.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_positional_shadow_atlas_quad_0:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **positional_shadow_atlas_quad_0** = ``2`` :ref:`🔗<class_Viewport_property_positional_shadow_atlas_quad_0>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>`\ )
|
||
- :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`\ ) |const|
|
||
|
||
Величина подразделения первого квадранта на теневом атласе.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_positional_shadow_atlas_quad_1:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **positional_shadow_atlas_quad_1** = ``2`` :ref:`🔗<class_Viewport_property_positional_shadow_atlas_quad_1>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>`\ )
|
||
- :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`\ ) |const|
|
||
|
||
Величина подразделения второго квадранта на теневом атласе.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_positional_shadow_atlas_quad_2:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **positional_shadow_atlas_quad_2** = ``3`` :ref:`🔗<class_Viewport_property_positional_shadow_atlas_quad_2>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>`\ )
|
||
- :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`\ ) |const|
|
||
|
||
Величина подразделения третьего квадранта на теневом атласе.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_positional_shadow_atlas_quad_3:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **positional_shadow_atlas_quad_3** = ``4`` :ref:`🔗<class_Viewport_property_positional_shadow_atlas_quad_3>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>`\ )
|
||
- :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`\ ) |const|
|
||
|
||
Величина подразделения четвертого квадранта на теневом атласе.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_positional_shadow_atlas_size:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **positional_shadow_atlas_size** = ``2048`` :ref:`🔗<class_Viewport_property_positional_shadow_atlas_size>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_positional_shadow_atlas_size**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_positional_shadow_atlas_size**\ (\ )
|
||
|
||
Разрешение теневого атласа (используется для всенаправленного и точечного освещения). Значение округляется до ближайшей степени 2.
|
||
|
||
\ **Примечание:** Если установлено значение ``0``, позиционные тени вообще не будут видны. Это может значительно повысить производительность на слабых системах за счет снижения нагрузки как на ЦП, так и на ГП (поскольку для отрисовки сцены без теней требуется меньше вызовов отрисовки).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_scaling_3d_mode:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` **scaling_3d_mode** = ``0`` :ref:`🔗<class_Viewport_property_scaling_3d_mode>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_scaling_3d_mode**\ (\ value\: :ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>`\ )
|
||
- :ref:`Scaling3DMode<enum_Viewport_Scaling3DMode>` **get_scaling_3d_mode**\ (\ )
|
||
|
||
Устанавливает режим масштабирования 3D. Билинейный масштаб рендерит с разным разрешением для либо недостаточной, либо избыточной выборки области просмотра. FidelityFX Super Resolution 1.0, сокращенно FSR, — это технология масштабирования, которая создает высококачественные изображения с высокой частотой кадров с помощью пространственно-ориентированного алгоритма масштабирования. FSR немного дороже билинейного, но обеспечивает значительно более высокое качество изображения. FSR следует использовать там, где это возможно.
|
||
|
||
Чтобы управлять этим свойством в корневой области просмотра, задайте настройку проекта :ref:`ProjectSettings.rendering/scaling_3d/mode<class_ProjectSettings_property_rendering/scaling_3d/mode>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_scaling_3d_scale:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **scaling_3d_scale** = ``1.0`` :ref:`🔗<class_Viewport_property_scaling_3d_scale>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_scaling_3d_scale**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_scaling_3d_scale**\ (\ )
|
||
|
||
Масштабирует буфер 3D-рендеринга на основе размера области просмотра, использует фильтр изображения, указанный в :ref:`ProjectSettings.rendering/scaling_3d/mode<class_ProjectSettings_property_rendering/scaling_3d/mode>`, для масштабирования выходного изображения до полного размера области просмотра. Значения ниже ``1.0`` можно использовать для ускорения 3D-рендеринга за счет качества (недостаточная выборка). Значения выше ``1.0`` допустимы только для билинейного режима и могут использоваться для улучшения качества 3D-рендеринга за счет высокой производительности (суперсэмплинг). См. также :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_3d>` для сглаживания с несколькими выборками, которое значительно дешевле, но сглаживает только края полигонов.
|
||
|
||
При использовании масштабирования FSR AMD рекомендует предоставлять пользователям следующие значения в качестве предустановленных параметров «Ультра качество: 0,77», «Качество: 0,67», «Сбалансированное: 0,59», «Производительность: 0,5» вместо предоставления всего масштаба.
|
||
|
||
Чтобы управлять этим свойством в корневом окне просмотра, задайте настройку проекта :ref:`ProjectSettings.rendering/scaling_3d/scale<class_ProjectSettings_property_rendering/scaling_3d/scale>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_screen_space_aa:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>` **screen_space_aa** = ``0`` :ref:`🔗<class_Viewport_property_screen_space_aa>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_screen_space_aa**\ (\ value\: :ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>`\ )
|
||
- :ref:`ScreenSpaceAA<enum_Viewport_ScreenSpaceAA>` **get_screen_space_aa**\ (\ )
|
||
|
||
Устанавливает используемый метод сглаживания экранного пространства. Сглаживание экранного пространства работает путем выборочного размывания краев в шейдере постобработки. Оно отличается от MSAA, который берет несколько образцов покрытия при рендеринге объектов. Методы сглаживания экранного пространства обычно быстрее, чем MSAA, и сглаживают зеркальное сглаживание, но, как правило, делают сцены размытыми.
|
||
|
||
См. также :ref:`ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa<class_ProjectSettings_property_rendering/anti_aliasing/quality/screen_space_aa>` и :ref:`RenderingServer.viewport_set_screen_space_aa()<class_RenderingServer_method_viewport_set_screen_space_aa>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_sdf_oversize:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`SDFOversize<enum_Viewport_SDFOversize>` **sdf_oversize** = ``1`` :ref:`🔗<class_Viewport_property_sdf_oversize>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_sdf_oversize**\ (\ value\: :ref:`SDFOversize<enum_Viewport_SDFOversize>`\ )
|
||
- :ref:`SDFOversize<enum_Viewport_SDFOversize>` **get_sdf_oversize**\ (\ )
|
||
|
||
Управляет тем, какая часть исходного размера области просмотра должна быть покрыта 2D-полем расстояния со знаком. Этот SDF может быть выбран в шейдерах :ref:`CanvasItem<class_CanvasItem>` и также используется для столкновения :ref:`GPUParticles2D<class_GPUParticles2D>`. Более высокие значения позволяют учитывать части окклюдеров, расположенных за пределами области просмотра, в сгенерированном поле расстояния со знаком, за счет производительности. Если вы заметили, что частицы падают через :ref:`LightOccluder2D<class_LightOccluder2D>`, когда окклюдеры покидают область просмотра, увеличьте этот параметр.
|
||
|
||
Процент добавляется на каждой оси и с обеих сторон. Например, при значении по умолчанию :ref:`SDF_OVERSIZE_120_PERCENT<class_Viewport_constant_SDF_OVERSIZE_120_PERCENT>` поле расстояния со знаком будет покрывать 20% размера области просмотра за пределами области просмотра с каждой стороны (сверху, справа, снизу, слева).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_sdf_scale:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`SDFScale<enum_Viewport_SDFScale>` **sdf_scale** = ``1`` :ref:`🔗<class_Viewport_property_sdf_scale>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_sdf_scale**\ (\ value\: :ref:`SDFScale<enum_Viewport_SDFScale>`\ )
|
||
- :ref:`SDFScale<enum_Viewport_SDFScale>` **get_sdf_scale**\ (\ )
|
||
|
||
Масштаб разрешения для использования в 2D-поле расстояний со знаком. Более высокие значения приводят к более точному и стабильному полю расстояний со знаком при движении камеры, за счет производительности.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_snap_2d_transforms_to_pixel:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **snap_2d_transforms_to_pixel** = ``false`` :ref:`🔗<class_Viewport_property_snap_2d_transforms_to_pixel>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_snap_2d_transforms_to_pixel**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_snap_2d_transforms_to_pixel_enabled**\ (\ )
|
||
|
||
Если ``true``, узлы :ref:`CanvasItem<class_CanvasItem>` будут внутренне привязаны к полным пикселям. Их положение все еще может быть субпиксельным, но десятичные знаки не будут иметь эффекта. Это может привести к более четкому виду за счет менее плавного движения, особенно если включено сглаживание :ref:`Camera2D<class_Camera2D>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_snap_2d_vertices_to_pixel:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **snap_2d_vertices_to_pixel** = ``false`` :ref:`🔗<class_Viewport_property_snap_2d_vertices_to_pixel>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_snap_2d_vertices_to_pixel**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_snap_2d_vertices_to_pixel_enabled**\ (\ )
|
||
|
||
Если ``true``, вершины узлов :ref:`CanvasItem<class_CanvasItem>` будут привязаны к полным пикселям. Влияет только на конечные положения вершин, а не на преобразования. Это может привести к более четкому виду за счет менее плавного движения, особенно если включено сглаживание :ref:`Camera2D<class_Camera2D>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_texture_mipmap_bias:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **texture_mipmap_bias** = ``0.0`` :ref:`🔗<class_Viewport_property_texture_mipmap_bias>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_texture_mipmap_bias**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_texture_mipmap_bias**\ (\ )
|
||
|
||
Влияет на окончательную резкость текстуры, считывая с более низкой или более высокой mip-карты (также называется «смещением уровня детализации текстуры»). Отрицательные значения делают текстуры с mip-картой более резкими, но более зернистыми при просмотре на расстоянии, в то время как положительные значения делают текстуры с mip-картой более размытыми (даже при просмотре вблизи).
|
||
|
||
Включение временного сглаживания (:ref:`use_taa<class_Viewport_property_use_taa>`) автоматически применит смещение ``-0.5`` к этому значению, а включение FXAA (:ref:`screen_space_aa<class_Viewport_property_screen_space_aa>`) автоматически применит смещение ``-0.25`` к этому значению. Если TAA и FXAA включены одновременно, к этому значению применяется смещение ``-0.75``.
|
||
|
||
\ **Примечание:** Если :ref:`scaling_3d_scale<class_Viewport_property_scaling_3d_scale>` ниже ``1.0`` (исключительно), :ref:`texture_mipmap_bias<class_Viewport_property_texture_mipmap_bias>` используется для настройки автоматического смещения mipmap, которое вычисляется внутренне на основе коэффициента масштабирования. Формула для этого: ``log2(scaling_3d_scale) + mipmap_bias``.
|
||
|
||
Чтобы управлять этим свойством в корневом окне просмотра, задайте настройку проекта :ref:`ProjectSettings.rendering/textures/default_filters/texture_mipmap_bias<class_ProjectSettings_property_rendering/textures/default_filters/texture_mipmap_bias>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_transparent_bg:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **transparent_bg** = ``false`` :ref:`🔗<class_Viewport_property_transparent_bg>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_transparent_background**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **has_transparent_background**\ (\ )
|
||
|
||
Если ``true``, то фон окна просмотра должен быть прозрачным.
|
||
|
||
\ **Примечание:** Из-за технических ограничений некоторые функции рендеринга отключаются, когда окно просмотра имеет прозрачный фон. В настоящее время это относится к отражениям в экранном пространстве, рассеиванию под поверхностью и глубине резкости (DOF).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_use_debanding:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **use_debanding** = ``false`` :ref:`🔗<class_Viewport_property_use_debanding>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_use_debanding**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_using_debanding**\ (\ )
|
||
|
||
When using the Mobile or Forward+ renderers, set :ref:`use_debanding<class_Viewport_property_use_debanding>` to enable or disable the debanding feature of this **Viewport**. If :ref:`use_hdr_2d<class_Viewport_property_use_hdr_2d>` is ``false``, 2D rendering is *not* affected by debanding unless the :ref:`Environment.background_mode<class_Environment_property_background_mode>` is :ref:`Environment.BG_CANVAS<class_Environment_constant_BG_CANVAS>`. If :ref:`use_hdr_2d<class_Viewport_property_use_hdr_2d>` is ``true``, debanding will only be applied if this is the root **Viewport** and will affect all 2D and 3D rendering, including canvas items.
|
||
|
||
\ :ref:`use_debanding<class_Viewport_property_use_debanding>` has no effect when using the Compatibility rendering method. The Mobile renderer can also use material debanding, which can be set with :ref:`RenderingServer.material_set_use_debanding()<class_RenderingServer_method_material_set_use_debanding>` or configured with :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>`.
|
||
|
||
See also :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>`, :ref:`RenderingServer.material_set_use_debanding()<class_RenderingServer_method_material_set_use_debanding>`, and :ref:`RenderingServer.viewport_set_use_debanding()<class_RenderingServer_method_viewport_set_use_debanding>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_use_hdr_2d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **use_hdr_2d** = ``false`` :ref:`🔗<class_Viewport_property_use_hdr_2d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_use_hdr_2d**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_using_hdr_2d**\ (\ )
|
||
|
||
If ``true``, 2D rendering will use a high dynamic range (HDR) ``RGBA16`` format framebuffer. Additionally, 2D rendering will be performed on linear values and will be converted using the appropriate transfer function immediately before blitting to the screen (if the Viewport is attached to the screen).
|
||
|
||
Practically speaking, this means that the end result of the Viewport will not be clamped to the ``0-1`` range and can be used in 3D rendering without color encoding adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_use_occlusion_culling:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **use_occlusion_culling** = ``false`` :ref:`🔗<class_Viewport_property_use_occlusion_culling>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_use_occlusion_culling**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_using_occlusion_culling**\ (\ )
|
||
|
||
Если ``true``, узлы :ref:`OccluderInstance3D<class_OccluderInstance3D>` будут использоваться для отсечения окклюзии в 3D для этого окна просмотра. Для корневого окна просмотра :ref:`ProjectSettings.rendering/occlusion_culling/use_occlusion_culling<class_ProjectSettings_property_rendering/occlusion_culling/use_occlusion_culling>` вместо этого должно быть установлено на ``true``.
|
||
|
||
\ **Примечание:** Включение отсечения окклюзии имеет затраты на ЦП. Включайте отсечение окклюзии только в том случае, если вы действительно планируете его использовать, и подумайте, может ли ваша сцена действительно выиграть от отсечения окклюзии. Большие открытые сцены с небольшим количеством или без объектов, блокирующих вид, как правило, не получат большой выгоды от отсечения окклюзии. Большие открытые сцены, как правило, больше выигрывают от LOD сетки и диапазонов видимости (:ref:`GeometryInstance3D.visibility_range_begin<class_GeometryInstance3D_property_visibility_range_begin>` и :ref:`GeometryInstance3D.visibility_range_end<class_GeometryInstance3D_property_visibility_range_end>`) по сравнению с отсечением окклюзии.
|
||
|
||
\ **Примечание:** Из-за ограничений памяти occlusion culling не поддерживается по умолчанию в шаблонах веб-экспорта. Его можно включить, скомпилировав пользовательские шаблоны веб-экспорта с ``module_raycast_enabled=yes``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_use_taa:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **use_taa** = ``false`` :ref:`🔗<class_Viewport_property_use_taa>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_use_taa**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_using_taa**\ (\ )
|
||
|
||
Включает временное сглаживание для этого окна просмотра. TAA работает путем дрожания камеры и накопления изображений последних отрисованных кадров, рендеринг вектора движения используется для учета движения камеры и объекта.
|
||
|
||
\ **Примечание:** Реализация еще не завершена, некоторые визуальные экземпляры, такие как частицы и сетки со скинами, могут показывать артефакты.
|
||
|
||
См. также :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>` и :ref:`RenderingServer.viewport_set_use_taa()<class_RenderingServer_method_viewport_set_use_taa>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_use_xr:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **use_xr** = ``false`` :ref:`🔗<class_Viewport_property_use_xr>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_use_xr**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_using_xr**\ (\ )
|
||
|
||
Если ``true``, область просмотра будет использовать основной интерфейс XR для рендеринга вывода XR. Когда это применимо, это может привести к стереоскопическому изображению и полученному рендеру, выводимому на гарнитуру.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_vrs_mode:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`VRSMode<enum_Viewport_VRSMode>` **vrs_mode** = ``0`` :ref:`🔗<class_Viewport_property_vrs_mode>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_vrs_mode**\ (\ value\: :ref:`VRSMode<enum_Viewport_VRSMode>`\ )
|
||
- :ref:`VRSMode<enum_Viewport_VRSMode>` **get_vrs_mode**\ (\ )
|
||
|
||
Режим Variable Rate Shading (VRS), используемый для этого окна просмотра. Обратите внимание, если оборудование не поддерживает VRS, это свойство игнорируется.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_vrs_texture:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Texture2D<class_Texture2D>` **vrs_texture** :ref:`🔗<class_Viewport_property_vrs_texture>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_vrs_texture**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
|
||
- :ref:`Texture2D<class_Texture2D>` **get_vrs_texture**\ (\ )
|
||
|
||
Текстура, используемая, когда :ref:`vrs_mode<class_Viewport_property_vrs_mode>` установлен на :ref:`VRS_TEXTURE<class_Viewport_constant_VRS_TEXTURE>`.
|
||
|
||
Текстура *должна* использовать формат сжатия без потерь, чтобы цвета можно было точно сопоставить. Следующие плотности VRS сопоставляются с различными цветами, причем более яркие цвета представляют более низкий уровень точности затенения:
|
||
|
||
.. code:: text
|
||
|
||
- 1×1 = rgb(0, 0, 0) - #000000
|
||
- 1×2 = rgb(0, 85, 0) - #005500
|
||
- 2×1 = rgb(85, 0, 0) - #550000
|
||
- 2×2 = rgb(85, 85, 0) - #555500
|
||
- 2×4 = rgb(85, 170, 0) - #55aa00
|
||
- 4×2 = rgb(170, 85, 0) - #aa5500
|
||
- 4×4 = rgb(170, 170, 0) - #aaaa00
|
||
- 4×8 = rgb(170, 255, 0) - #aaff00 - Не поддерживается на большинстве оборудования
|
||
- 8×4 = rgb(255, 170, 0) - #ffaa00 - Не поддерживается на большинстве оборудования
|
||
- 8×8 = rgb(255, 255, 0) - #ffff00 - Не поддерживается на большинстве оборудования
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_vrs_update_mode:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>` **vrs_update_mode** = ``1`` :ref:`🔗<class_Viewport_property_vrs_update_mode>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_vrs_update_mode**\ (\ value\: :ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>`\ )
|
||
- :ref:`VRSUpdateMode<enum_Viewport_VRSUpdateMode>` **get_vrs_update_mode**\ (\ )
|
||
|
||
Устанавливает режим обновления для Variable Rate Shading (VRS) для области просмотра. VRS требует, чтобы входная текстура была преобразована в формат, используемый методом VRS, поддерживаемым оборудованием. Режим обновления определяет, как часто это происходит. Если графический процессор не поддерживает VRS или VRS не включен, это свойство игнорируется.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_world_2d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`World2D<class_World2D>` **world_2d** :ref:`🔗<class_Viewport_property_world_2d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_world_2d**\ (\ value\: :ref:`World2D<class_World2D>`\ )
|
||
- :ref:`World2D<class_World2D>` **get_world_2d**\ (\ )
|
||
|
||
Пользовательский :ref:`World2D<class_World2D>`, который можно использовать в качестве источника 2D-среды.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_property_world_3d:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`World3D<class_World3D>` **world_3d** :ref:`🔗<class_Viewport_property_world_3d>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_world_3d**\ (\ value\: :ref:`World3D<class_World3D>`\ )
|
||
- :ref:`World3D<class_World3D>` **get_world_3d**\ (\ )
|
||
|
||
Пользовательский :ref:`World3D<class_World3D>`, который можно использовать в качестве источника 3D-среды.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описания метода
|
||
------------------------------
|
||
|
||
.. _class_Viewport_method_find_world_2d:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`World2D<class_World2D>` **find_world_2d**\ (\ ) |const| :ref:`🔗<class_Viewport_method_find_world_2d>`
|
||
|
||
Возвращает первый допустимый :ref:`World2D<class_World2D>` для данного окна просмотра, выполняя поиск по свойству :ref:`world_2d<class_Viewport_property_world_2d>` самого себя и любого предка окна просмотра.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_find_world_3d:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`World3D<class_World3D>` **find_world_3d**\ (\ ) |const| :ref:`🔗<class_Viewport_method_find_world_3d>`
|
||
|
||
Возвращает первый допустимый :ref:`World3D<class_World3D>` для данного окна просмотра, выполняя поиск по свойству :ref:`world_3d<class_Viewport_property_world_3d>` самого себя и любого предка окна просмотра.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_audio_listener_2d:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`AudioListener2D<class_AudioListener2D>` **get_audio_listener_2d**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_audio_listener_2d>`
|
||
|
||
Возвращает текущий активный прослушиватель 2D-аудио. Возвращает ``null``, если нет активных прослушивателей 2D-аудио, в этом случае активная 2D-камера будет рассматриваться как прослушиватель.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_audio_listener_3d:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`AudioListener3D<class_AudioListener3D>` **get_audio_listener_3d**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_audio_listener_3d>`
|
||
|
||
Возвращает текущий активный прослушиватель 3D-аудио. Возвращает ``null``, если нет активных прослушивателей 3D-аудио, в этом случае активная 3D-камера будет рассматриваться как прослушиватель.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_camera_2d:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Camera2D<class_Camera2D>` **get_camera_2d**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_camera_2d>`
|
||
|
||
Returns the currently active 2D camera. Returns ``null`` if there are no active cameras.
|
||
|
||
\ **Note:** If called while the *Camera Override* system is active in editor, this will return the internally managed override camera. It is therefore advised to avoid caching the return value, or to check that the cached value is still a valid instance and is the current camera before use. See :ref:`@GlobalScope.is_instance_valid()<class_@GlobalScope_method_is_instance_valid>` and :ref:`Camera2D.is_current()<class_Camera2D_method_is_current>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_camera_3d:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Camera3D<class_Camera3D>` **get_camera_3d**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_camera_3d>`
|
||
|
||
Returns the currently active 3D camera. Returns ``null`` if there are no active cameras.
|
||
|
||
\ **Note:** If called while the *Camera Override* system is active in editor, this will return the internally managed override camera. It is therefore advised to avoid caching the return value, or to check that the cached value is a valid instance and is the current camera before use. See :ref:`@GlobalScope.is_instance_valid()<class_@GlobalScope_method_is_instance_valid>` and :ref:`Camera3D.current<class_Camera3D_property_current>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_canvas_cull_mask_bit:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **get_canvas_cull_mask_bit**\ (\ layer\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_Viewport_method_get_canvas_cull_mask_bit>`
|
||
|
||
Возвращает отдельный бит в маске слоя рендеринга.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_embedded_subwindows:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Array<class_Array>`\[:ref:`Window<class_Window>`\] **get_embedded_subwindows**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_embedded_subwindows>`
|
||
|
||
Возвращает список видимых встроенных :ref:`Window<class_Window>` внутри области просмотра.
|
||
|
||
\ **Примечание:** :ref:`Window<class_Window>` внутри других областей просмотра не будут перечислены.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_final_transform:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Transform2D<class_Transform2D>` **get_final_transform**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_final_transform>`
|
||
|
||
Возвращает преобразование из системы координат области просмотра в систему координат средства внедрения.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_mouse_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2<class_Vector2>` **get_mouse_position**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_mouse_position>`
|
||
|
||
Возвращает положение мыши в этом **Viewport**, используя систему координат этого **Viewport**.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_oversampling:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **get_oversampling**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_oversampling>`
|
||
|
||
Возвращает коэффициент передискретизации области просмотра.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_positional_shadow_atlas_quadrant_subdiv:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>` **get_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_Viewport_method_get_positional_shadow_atlas_quadrant_subdiv>`
|
||
|
||
Возвращает позиционное подразделение квадранта теневого атласа указанного квадранта.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_render_info:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`int<class_int>` **get_render_info**\ (\ type\: :ref:`RenderInfoType<enum_Viewport_RenderInfoType>`, info\: :ref:`RenderInfo<enum_Viewport_RenderInfo>`\ ) :ref:`🔗<class_Viewport_method_get_render_info>`
|
||
|
||
Возвращает статистику рендеринга указанного типа.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_screen_transform:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Transform2D<class_Transform2D>` **get_screen_transform**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_screen_transform>`
|
||
|
||
Возвращает преобразование из координат области просмотра в экранные координаты содержащего ее окна оконного менеджера.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_stretch_transform:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Transform2D<class_Transform2D>` **get_stretch_transform**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_stretch_transform>`
|
||
|
||
Возвращает автоматически вычисленное 2D-преобразование растяжения, принимая во внимание настройки растяжения **Viewport**. Конечное значение умножается на :ref:`Window.content_scale_factor<class_Window_property_content_scale_factor>`, но только для корневого окна просмотра. Если этот метод вызывается для :ref:`SubViewport<class_SubViewport>` (например, в дереве сцены с :ref:`SubViewportContainer<class_SubViewportContainer>` и :ref:`SubViewport<class_SubViewport>`), коэффициент масштабирования корневого окна не будет применен. Используя :ref:`Transform2D.get_scale()<class_Transform2D_method_get_scale>` для возвращаемого значения, это можно использовать для компенсации масштабирования при масштабировании узла :ref:`Camera2D<class_Camera2D>` или для уменьшения масштаба :ref:`TextureRect<class_TextureRect>` до пиксельного совершенства независимо от автоматически вычисленного коэффициента масштабирования.
|
||
|
||
\ **Примечание:** Из-за того, как работает масштабирование пикселей, масштаб возвращаемого преобразования по осям X и Y может немного отличаться, даже если :ref:`Window.content_scale_aspect<class_Window_property_content_scale_aspect>` установлен в режим, который сохраняет соотношение сторон пикселей. Если :ref:`Window.content_scale_aspect<class_Window_property_content_scale_aspect>` равен :ref:`Window.CONTENT_SCALE_ASPECT_IGNORE<class_Window_constant_CONTENT_SCALE_ASPECT_IGNORE>`, масштабы X и Y могут отличаться *значительно*.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_texture:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`ViewportTexture<class_ViewportTexture>` **get_texture**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_texture>`
|
||
|
||
Returns the viewport's texture.
|
||
|
||
\ **Note:** When trying to store the current texture (e.g. in a file), it might be completely black or outdated if used too early, especially when used in e.g. :ref:`Node._ready()<class_Node_private_method__ready>`. To make sure the texture you get is correct, you can await :ref:`RenderingServer.frame_post_draw<class_RenderingServer_signal_frame_post_draw>` signal.
|
||
|
||
|
||
.. tabs::
|
||
|
||
.. code-tab:: gdscript
|
||
|
||
func _ready():
|
||
await RenderingServer.frame_post_draw
|
||
$Viewport.get_texture().get_image().save_png("user://Screenshot.png")
|
||
|
||
.. code-tab:: csharp
|
||
|
||
public async override void _Ready()
|
||
{
|
||
await ToSignal(RenderingServer.Singleton, RenderingServer.SignalName.FramePostDraw);
|
||
var viewport = GetNode<Viewport>("Viewport");
|
||
viewport.GetTexture().GetImage().SavePng("user://Screenshot.png");
|
||
}
|
||
|
||
|
||
|
||
\ **Note:** When :ref:`use_hdr_2d<class_Viewport_property_use_hdr_2d>` is ``true`` the returned texture will be an HDR image using linear encoding.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_viewport_rid:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`RID<class_RID>` **get_viewport_rid**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_viewport_rid>`
|
||
|
||
Возвращает RID области просмотра из :ref:`RenderingServer<class_RenderingServer>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_get_visible_rect:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Rect2<class_Rect2>` **get_visible_rect**\ (\ ) |const| :ref:`🔗<class_Viewport_method_get_visible_rect>`
|
||
|
||
Возвращает видимый прямоугольник в глобальных экранных координатах.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_cancel_drag:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **gui_cancel_drag**\ (\ ) :ref:`🔗<class_Viewport_method_gui_cancel_drag>`
|
||
|
||
Отменяет операцию перетаскивания, которая была ранее запущена с помощью :ref:`Control._get_drag_data()<class_Control_private_method__get_drag_data>` или принудительно запущена с помощью :ref:`Control.force_drag()<class_Control_method_force_drag>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_get_drag_data:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Variant<class_Variant>` **gui_get_drag_data**\ (\ ) |const| :ref:`🔗<class_Viewport_method_gui_get_drag_data>`
|
||
|
||
Возвращает данные перетаскивания из графического интерфейса пользователя, которые ранее возвращались :ref:`Control._get_drag_data()<class_Control_private_method__get_drag_data>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_get_drag_description:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`String<class_String>` **gui_get_drag_description**\ (\ ) |const| :ref:`🔗<class_Viewport_method_gui_get_drag_description>`
|
||
|
||
Returns the human-readable description of the drag data, used for assistive apps.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_get_focus_owner:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Control<class_Control>` **gui_get_focus_owner**\ (\ ) |const| :ref:`🔗<class_Viewport_method_gui_get_focus_owner>`
|
||
|
||
Возвращает текущий сфокусированный :ref:`Control<class_Control>` в этом окне просмотра. Если нет сфокусированного :ref:`Control<class_Control>`, возвращает ``null``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_get_hovered_control:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Control<class_Control>` **gui_get_hovered_control**\ (\ ) |const| :ref:`🔗<class_Viewport_method_gui_get_hovered_control>`
|
||
|
||
Возвращает :ref:`Control<class_Control>`, над которым в данный момент находится мышь в этом окне просмотра. Если ни один :ref:`Control<class_Control>` не имеет курсора, возвращает ``null``.
|
||
|
||
Обычно это листовой узел :ref:`Control<class_Control>` или самый глубокий уровень поддерева, который заявляет наведение. Это очень полезно при использовании вместе с :ref:`Node.is_ancestor_of()<class_Node_method_is_ancestor_of>`, чтобы определить, находится ли мышь в дереве элементов управления.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_is_drag_successful:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **gui_is_drag_successful**\ (\ ) |const| :ref:`🔗<class_Viewport_method_gui_is_drag_successful>`
|
||
|
||
Возвращает ``true``, если операция перетаскивания прошла успешно.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_is_dragging:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **gui_is_dragging**\ (\ ) |const| :ref:`🔗<class_Viewport_method_gui_is_dragging>`
|
||
|
||
Возвращает ``true``, если операция перетаскивания в данный момент выполняется и где действие сброса может произойти в этом окне просмотра.
|
||
|
||
Альтернатива :ref:`Node.NOTIFICATION_DRAG_BEGIN<class_Node_constant_NOTIFICATION_DRAG_BEGIN>` и :ref:`Node.NOTIFICATION_DRAG_END<class_Node_constant_NOTIFICATION_DRAG_END>`, когда вы предпочитаете опрос значения.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_release_focus:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **gui_release_focus**\ (\ ) :ref:`🔗<class_Viewport_method_gui_release_focus>`
|
||
|
||
Удаляет фокус с текущего сфокусированного :ref:`Control<class_Control>` в этом окне просмотра. Если фокуса нет ни у одного :ref:`Control<class_Control>`, ничего не делает.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_gui_set_drag_description:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **gui_set_drag_description**\ (\ description\: :ref:`String<class_String>`\ ) :ref:`🔗<class_Viewport_method_gui_set_drag_description>`
|
||
|
||
Sets the human-readable description of the drag data to ``description``, used for assistive apps.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_is_input_handled:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_input_handled**\ (\ ) |const| :ref:`🔗<class_Viewport_method_is_input_handled>`
|
||
|
||
Возвращает, был ли обработан текущий :ref:`InputEvent<class_InputEvent>`. События ввода не обрабатываются, пока не будет вызван :ref:`set_input_as_handled()<class_Viewport_method_set_input_as_handled>` в течение жизненного цикла :ref:`InputEvent<class_InputEvent>`.
|
||
|
||
Обычно это делается как часть методов обработки ввода, таких как :ref:`Node._input()<class_Node_private_method__input>`, :ref:`Control._gui_input()<class_Control_private_method__gui_input>` или других, а также в соответствующих обработчиках сигналов.
|
||
|
||
Если :ref:`handle_input_locally<class_Viewport_property_handle_input_locally>` установлен в ``false``, этот метод попытается найти первую родительскую область просмотра, которая настроена на локальную обработку ввода, и вместо этого вернет его значение для :ref:`is_input_handled()<class_Viewport_method_is_input_handled>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_notify_mouse_entered:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **notify_mouse_entered**\ (\ ) :ref:`🔗<class_Viewport_method_notify_mouse_entered>`
|
||
|
||
Сообщите Viewport, что мышь вошла в его область. Используйте эту функцию перед отправкой :ref:`InputEventMouseButton<class_InputEventMouseButton>` или :ref:`InputEventMouseMotion<class_InputEventMouseMotion>` в **Viewport** с помощью :ref:`push_input()<class_Viewport_method_push_input>`. См. также :ref:`notify_mouse_exited()<class_Viewport_method_notify_mouse_exited>`.
|
||
|
||
\ **Примечание:** В большинстве случаев нет необходимости вызывать эту функцию, поскольку узлы :ref:`SubViewport<class_SubViewport>`, которые являются дочерними элементами :ref:`SubViewportContainer<class_SubViewportContainer>`, уведомляются автоматически. Это необходимо только при взаимодействии с viewport нестандартными способами, например, как текстуры в :ref:`TextureRect<class_TextureRect>` или с :ref:`Area3D<class_Area3D>`, который пересылает события ввода.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_notify_mouse_exited:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **notify_mouse_exited**\ (\ ) :ref:`🔗<class_Viewport_method_notify_mouse_exited>`
|
||
|
||
Сообщить Viewport, что мышь покинула его область. Используйте эту функцию, когда узел, отображающий viewport, замечает, что мышь покинула область отображаемого viewport. См. также :ref:`notify_mouse_entered()<class_Viewport_method_notify_mouse_entered>`.
|
||
|
||
\ **Примечание:** В большинстве случаев нет необходимости вызывать эту функцию, поскольку узлы :ref:`SubViewport<class_SubViewport>`, которые являются дочерними элементами :ref:`SubViewportContainer<class_SubViewportContainer>`, уведомляются автоматически. Это необходимо только при взаимодействии с viewports нестандартными способами, например, как текстуры в :ref:`TextureRect<class_TextureRect>` или с :ref:`Area3D<class_Area3D>`, который пересылает события ввода.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_push_input:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **push_input**\ (\ event\: :ref:`InputEvent<class_InputEvent>`, in_local_coords\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_Viewport_method_push_input>`
|
||
|
||
Запускает заданное ``event`` в этом **Viewport**. Это можно использовать для передачи :ref:`InputEvent<class_InputEvent>` между viewport или для локального применения входных данных, отправленных по сети или сохраненных в файле.
|
||
|
||
Если ``in_local_coords`` имеет значение ``false``, позиция события находится в координатах встраиваемого устройства и будет преобразована в координаты viewport. Если ``in_local_coords`` имеет значение ``true``, позиция события находится в координатах viewport.
|
||
|
||
Хотя этот метод служит той же цели, что и :ref:`Input.parse_input_event()<class_Input_method_parse_input_event>`, он не переназначает указанное ``event`` на основе настроек проекта, таких как :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse<class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse>`.
|
||
|
||
Вызов этого метода распространит вызовы на дочерние узлы для следующих методов в указанном порядке:
|
||
|
||
- :ref:`Node._input()<class_Node_private_method__input>`\
|
||
|
||
- :ref:`Control._gui_input()<class_Control_private_method__gui_input>` для узлов :ref:`Control<class_Control>`\
|
||
|
||
- :ref:`Node._shortcut_input()<class_Node_private_method__shortcut_input>`\
|
||
|
||
- :ref:`Node._unhandled_key_input()<class_Node_private_method__unhandled_key_input>`\
|
||
|
||
- :ref:`Node._unhandled_input()<class_Node_private_method__unhandled_input>`\
|
||
|
||
Если более ранний метод помечает ввод как обработанный с помощью :ref:`set_input_as_handled()<class_Viewport_method_set_input_as_handled>`, любой более поздний метод в этом списке не будет вызван.
|
||
|
||
Если ни один из методов не обрабатывает событие и :ref:`physics_object_picking<class_Viewport_property_physics_object_picking>` равен ``true``, событие используется для выбора физического объекта.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_push_text_input:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **push_text_input**\ (\ text\: :ref:`String<class_String>`\ ) :ref:`🔗<class_Viewport_method_push_text_input>`
|
||
|
||
Вспомогательный метод, который вызывает метод ``set_text()`` для текущего сфокусированного элемента управления :ref:`Control<class_Control>`, при условии, что он определен (например, если сфокусированный элемент управления — :ref:`Button<class_Button>` или :ref:`LineEdit<class_LineEdit>`).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_push_unhandled_input:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **push_unhandled_input**\ (\ event\: :ref:`InputEvent<class_InputEvent>`, in_local_coords\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_Viewport_method_push_unhandled_input>`
|
||
|
||
**Устарело:** Use :ref:`push_input()<class_Viewport_method_push_input>` instead.
|
||
|
||
Запускает заданное ``event`` в этом **Viewport**. Это можно использовать для передачи :ref:`InputEvent<class_InputEvent>` между viewport или для локального применения входных данных, отправленных по сети или сохраненных в файле.
|
||
|
||
Если ``in_local_coords`` равно ``false``, позиция события находится в координатах встраиваемого устройства и будет преобразована в координаты viewport. Если ``in_local_coords`` равно ``true``, позиция события находится в координатах viewport.
|
||
|
||
Вызов этого метода распространит вызовы дочерних узлов для следующих методов в указанном порядке:
|
||
|
||
- :ref:`Node._shortcut_input()<class_Node_private_method__shortcut_input>`\
|
||
|
||
- :ref:`Node._unhandled_key_input()<class_Node_private_method__unhandled_key_input>`\
|
||
|
||
- :ref:`Node._unhandled_input()<class_Node_private_method__unhandled_input>`\
|
||
|
||
Если более ранний метод помечает ввод как обработанный с помощью :ref:`set_input_as_handled()<class_Viewport_method_set_input_as_handled>`, любой более поздний метод в этом списке не будет вызван.
|
||
|
||
Если ни один из методов не обрабатывает событие и :ref:`physics_object_picking<class_Viewport_property_physics_object_picking>` равен ``true``, событие используется для выбора физического объекта.
|
||
|
||
\ **Примечание:** Этот метод не распространяет события ввода на встроенные :ref:`Window<class_Window>` или :ref:`SubViewport<class_SubViewport>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_set_canvas_cull_mask_bit:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_canvas_cull_mask_bit**\ (\ layer\: :ref:`int<class_int>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_Viewport_method_set_canvas_cull_mask_bit>`
|
||
|
||
Установить/снять отдельные биты на маске слоя рендеринга. Это упрощает редактирование слоев этого **Viewport**.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_set_input_as_handled:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_input_as_handled**\ (\ ) :ref:`🔗<class_Viewport_method_set_input_as_handled>`
|
||
|
||
Stops the input from propagating further up the :ref:`SceneTree<class_SceneTree>`.
|
||
|
||
\ **Note:** This does not affect the methods in :ref:`Input<class_Input>`, only the way events are propagated.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_set_positional_shadow_atlas_quadrant_subdiv:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_positional_shadow_atlas_quadrant_subdiv**\ (\ quadrant\: :ref:`int<class_int>`, subdiv\: :ref:`PositionalShadowAtlasQuadrantSubdiv<enum_Viewport_PositionalShadowAtlasQuadrantSubdiv>`\ ) :ref:`🔗<class_Viewport_method_set_positional_shadow_atlas_quadrant_subdiv>`
|
||
|
||
Устанавливает количество подразделов для использования в указанном квадранте. Большее количество подразделов позволяет иметь больше теней в сцене одновременно, но снижает качество теней. Хорошей практикой является наличие квадрантов с различным количеством подразделов и как можно меньшим количеством подразделов.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_update_mouse_cursor_state:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **update_mouse_cursor_state**\ (\ ) :ref:`🔗<class_Viewport_method_update_mouse_cursor_state>`
|
||
|
||
Принудительно мгновенно обновлять дисплей на основе текущего положения курсора мыши. Это включает обновление формы курсора мыши и отправку необходимых сигналов :ref:`Control.mouse_entered<class_Control_signal_mouse_entered>`, :ref:`CollisionObject2D.mouse_entered<class_CollisionObject2D_signal_mouse_entered>`, :ref:`CollisionObject3D.mouse_entered<class_CollisionObject3D_signal_mouse_entered>` и :ref:`Window.mouse_entered<class_Window_signal_mouse_entered>` и их соответствующих аналогов ``mouse_exited``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_Viewport_method_warp_mouse:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **warp_mouse**\ (\ position\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_Viewport_method_warp_mouse>`
|
||
|
||
Перемещает указатель мыши в указанную позицию в этом **Viewport**, используя систему координат этого **Viewport**.
|
||
|
||
\ **Примечание:** :ref:`warp_mouse()<class_Viewport_method_warp_mouse>` поддерживается только в Windows, macOS и Linux. Он не действует на Android, iOS и Web.
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)`
|
||
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
||
.. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)`
|
||
.. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)`
|
||
.. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)`
|
||
.. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)`
|
||
.. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)`
|
||
.. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)`
|
||
.. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`
|