:github_url: hide .. _class_RenderingServer: RenderingServer =============== **继承：** :ref:`Object` 任何可见的东西的服务器。 .. rst-class:: classref-introduction-group 描述 ---- 渲染服务器是所有可见内容的 API 后端。整个场景系统都挂载在它上面来显示。渲染服务器是完全不透明的：内部实现完全取决于具体的实现，无法进行访问。 使用渲染服务器可以完全绕过场景和 :ref:`Node` 系统。如果场景系统是瓶颈所在，那么这样做就可以提升性能，否则无法提升性能（例如已经完全利用 GPU 的情况）。 资源是使用 ``*_create`` 函数创建的。这些函数返回的 :ref:`RID` 并不是对对象本身的引用，而是指向这些对象的不透明\ *指针*\ 。 所有对象都会被绘制到视口中。你可以使用附加到 :ref:`SceneTree` 的 :ref:`Viewport`\ ，或者也可以使用 :ref:`viewport_create()` 自行创建。使用自定义场景或画布时，需要使用 :ref:`viewport_set_scenario()` 或 :ref:`viewport_attach_canvas()` 将场景或画布附加到视口。 \ **场景：**\ 在 3D 中，所有可视对象都必须与一个场景（Scenario）相关联。场景是世界的可视化表示。如果要从正在运行的游戏中访问渲染服务器，那么就可以使用 :ref:`Node3D.get_world_3d()` 从任何 :ref:`Node3D` 节点的场景树访问该场景。此外，也可以使用 :ref:`scenario_create()` 创建场景。 在 2D 中也是类似的，需要一个画布（Canvas）来绘制所有的画布项。 \ **3D：**\ 在 3D 中，所有可视对象都由资源（Resource）和实例（Instance）组成。资源可以是网格、粒子系统、灯光或任何其他 3D 对象。为了使资源可见，必须使用 :ref:`instance_set_base()` 将其附加到一个实例。该实例还必须使用 :ref:`instance_set_scenario()` 附加到场景中才可见。不带前缀的 RenderingServer 方法通常都是针对 3D 的（但也有例外）。 \ **2D：**\ 在 2D 中，所有可见对象都是某种形式的画布项（Canvas Item）。为了使画布项可见，就需要让它成为附加到视口的画布的子项，或者需要让它成为其他画布项的子项，但这些画布项最终也需要是画布的子项。针对 2D 的 RenderingServer 方法一般都以 ``canvas_*`` 开头。 \ **无头模式：**\ 使用 ``--headless`` :doc:`命令行参数 <../tutorials/editor/command_line_tutorial>`\ 启动引擎将禁用所有渲染和窗口管理功能。在这种情况下，\ **RenderingServer** 中的大多数函数将返回虚设值。 .. rst-class:: classref-introduction-group 教程 ---- - :doc:`使用服务器进行优化 <../tutorials/performance/using_servers>` .. rst-class:: classref-reftable-group 属性 ---- .. table:: :widths: auto +-------------------------+--------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`render_loop_enabled` | +-------------------------+--------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group 方法 ---- .. table:: :widths: auto +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Image`\] | :ref:`bake_render_uv2`\ (\ base\: :ref:`RID`, material_overrides\: :ref:`Array`\[:ref:`RID`\], image_size\: :ref:`Vector2i`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`call_on_render_thread`\ (\ callable\: :ref:`Callable`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`camera_attributes_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_attributes_set_auto_exposure`\ (\ camera_attributes\: :ref:`RID`, enable\: :ref:`bool`, min_sensitivity\: :ref:`float`, max_sensitivity\: :ref:`float`, speed\: :ref:`float`, scale\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_attributes_set_dof_blur`\ (\ camera_attributes\: :ref:`RID`, far_enable\: :ref:`bool`, far_distance\: :ref:`float`, far_transition\: :ref:`float`, near_enable\: :ref:`bool`, near_distance\: :ref:`float`, near_transition\: :ref:`float`, amount\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_attributes_set_dof_blur_bokeh_shape`\ (\ shape\: :ref:`DOFBokehShape`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_attributes_set_dof_blur_quality`\ (\ quality\: :ref:`DOFBlurQuality`, use_jitter\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_attributes_set_exposure`\ (\ camera_attributes\: :ref:`RID`, multiplier\: :ref:`float`, normalization\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`camera_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_camera_attributes`\ (\ camera\: :ref:`RID`, effects\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_compositor`\ (\ camera\: :ref:`RID`, compositor\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_cull_mask`\ (\ camera\: :ref:`RID`, layers\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_environment`\ (\ camera\: :ref:`RID`, env\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_frustum`\ (\ camera\: :ref:`RID`, size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_orthogonal`\ (\ camera\: :ref:`RID`, size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_perspective`\ (\ camera\: :ref:`RID`, fovy_degrees\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_transform`\ (\ camera\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`camera_set_use_vertical_aspect`\ (\ camera\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_animation_slice`\ (\ item\: :ref:`RID`, animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_circle`\ (\ item\: :ref:`RID`, pos\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_clip_ignore`\ (\ item\: :ref:`RID`, ignore\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_ellipse`\ (\ item\: :ref:`RID`, pos\: :ref:`Vector2`, major\: :ref:`float`, minor\: :ref:`float`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_lcd_texture_rect_region`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_line`\ (\ item\: :ref:`RID`, from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_mesh`\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1), texture\: :ref:`RID` = RID()\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_msdf_texture_rect_region`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, px_range\: :ref:`float` = 1.0, scale\: :ref:`float` = 1.0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_multiline`\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_multimesh`\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, texture\: :ref:`RID` = RID()\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_nine_patch`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, source\: :ref:`Rect2`, texture\: :ref:`RID`, topleft\: :ref:`Vector2`, bottomright\: :ref:`Vector2`, x_axis_mode\: :ref:`NinePatchAxisMode` = 0, y_axis_mode\: :ref:`NinePatchAxisMode` = 0, draw_center\: :ref:`bool` = true, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_particles`\ (\ item\: :ref:`RID`, particles\: :ref:`RID`, texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_polygon`\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`RID` = RID()\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_polyline`\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_primitive`\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_rect`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_set_transform`\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_texture_rect`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, tile\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_texture_rect_region`\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_add_triangle_array`\ (\ item\: :ref:`RID`, indices\: :ref:`PackedInt32Array`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), bones\: :ref:`PackedInt32Array` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array` = PackedFloat32Array(), texture\: :ref:`RID` = RID(), count\: :ref:`int` = -1\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_attach_skeleton`\ (\ item\: :ref:`RID`, skeleton\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_clear`\ (\ item\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_item_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`canvas_item_get_instance_shader_parameter`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`canvas_item_get_instance_shader_parameter_default_value`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`canvas_item_get_instance_shader_parameter_list`\ (\ instance\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_reset_physics_interpolation`\ (\ item\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_canvas_group_mode`\ (\ item\: :ref:`RID`, mode\: :ref:`CanvasGroupMode`, clear_margin\: :ref:`float` = 5.0, fit_empty\: :ref:`bool` = false, fit_margin\: :ref:`float` = 0.0, blur_mipmaps\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_clip`\ (\ item\: :ref:`RID`, clip\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_copy_to_backbuffer`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`, rect\: :ref:`Rect2`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_custom_rect`\ (\ item\: :ref:`RID`, use_custom_rect\: :ref:`bool`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_default_texture_filter`\ (\ item\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_default_texture_repeat`\ (\ item\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_distance_field_mode`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_draw_behind_parent`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_draw_index`\ (\ item\: :ref:`RID`, index\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_instance_shader_parameter`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_interpolated`\ (\ item\: :ref:`RID`, interpolated\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_light_mask`\ (\ item\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_material`\ (\ item\: :ref:`RID`, material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_modulate`\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_parent`\ (\ item\: :ref:`RID`, parent\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_self_modulate`\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_sort_children_by_y`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_transform`\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_use_parent_material`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_visibility_layer`\ (\ item\: :ref:`RID`, visibility_layer\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_visibility_notifier`\ (\ item\: :ref:`RID`, enable\: :ref:`bool`, area\: :ref:`Rect2`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_visible`\ (\ item\: :ref:`RID`, visible\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_z_as_relative_to_parent`\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_set_z_index`\ (\ item\: :ref:`RID`, z_index\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_item_transform_physics_interpolation`\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_attach_to_canvas`\ (\ light\: :ref:`RID`, canvas\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_light_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_attach_to_canvas`\ (\ occluder\: :ref:`RID`, canvas\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_light_occluder_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_reset_physics_interpolation`\ (\ occluder\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_set_as_sdf_collision`\ (\ occluder\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_set_enabled`\ (\ occluder\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_set_interpolated`\ (\ occluder\: :ref:`RID`, interpolated\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_set_light_mask`\ (\ occluder\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_set_polygon`\ (\ occluder\: :ref:`RID`, polygon\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_set_transform`\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_occluder_transform_physics_interpolation`\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_reset_physics_interpolation`\ (\ light\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_blend_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightBlendMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_color`\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_enabled`\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_energy`\ (\ light\: :ref:`RID`, energy\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_height`\ (\ light\: :ref:`RID`, height\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_interpolated`\ (\ light\: :ref:`RID`, interpolated\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_item_cull_mask`\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_item_shadow_cull_mask`\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_layer_range`\ (\ light\: :ref:`RID`, min_layer\: :ref:`int`, max_layer\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_shadow_color`\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_shadow_enabled`\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_shadow_filter`\ (\ light\: :ref:`RID`, filter\: :ref:`CanvasLightShadowFilter`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_shadow_smooth`\ (\ light\: :ref:`RID`, smooth\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_texture`\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_texture_offset`\ (\ light\: :ref:`RID`, offset\: :ref:`Vector2`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_texture_scale`\ (\ light\: :ref:`RID`, scale\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_transform`\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_set_z_range`\ (\ light\: :ref:`RID`, min_z\: :ref:`int`, max_z\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_light_transform_physics_interpolation`\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_occluder_polygon_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_occluder_polygon_set_cull_mode`\ (\ occluder_polygon\: :ref:`RID`, mode\: :ref:`CanvasOccluderPolygonCullMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_occluder_polygon_set_shape`\ (\ occluder_polygon\: :ref:`RID`, shape\: :ref:`PackedVector2Array`, closed\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_set_disable_scale`\ (\ disable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_set_item_mirroring`\ (\ canvas\: :ref:`RID`, item\: :ref:`RID`, mirroring\: :ref:`Vector2`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_set_item_repeat`\ (\ item\: :ref:`RID`, repeat_size\: :ref:`Vector2`, repeat_times\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_set_modulate`\ (\ canvas\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_set_shadow_texture_size`\ (\ size\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_texture_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_texture_set_channel`\ (\ canvas_texture\: :ref:`RID`, channel\: :ref:`CanvasTextureChannel`, texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_texture_set_shading_parameters`\ (\ canvas_texture\: :ref:`RID`, base_color\: :ref:`Color`, shininess\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_texture_set_texture_filter`\ (\ canvas_texture\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`canvas_texture_set_texture_repeat`\ (\ canvas_texture\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`compositor_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`compositor_effect_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`compositor_effect_set_callback`\ (\ effect\: :ref:`RID`, callback_type\: :ref:`CompositorEffectCallbackType`, callback\: :ref:`Callable`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`compositor_effect_set_enabled`\ (\ effect\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`compositor_effect_set_flag`\ (\ effect\: :ref:`RID`, flag\: :ref:`CompositorEffectFlags`, set\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`compositor_set_compositor_effects`\ (\ compositor\: :ref:`RID`, effects\: :ref:`Array`\[:ref:`RID`\]\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RenderingDevice` | :ref:`create_local_rendering_device`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`debug_canvas_item_get_rect`\ (\ item\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`decal_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_albedo_mix`\ (\ decal\: :ref:`RID`, albedo_mix\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_cull_mask`\ (\ decal\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_distance_fade`\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, length\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_emission_energy`\ (\ decal\: :ref:`RID`, energy\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_fade`\ (\ decal\: :ref:`RID`, above\: :ref:`float`, below\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_modulate`\ (\ decal\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_normal_fade`\ (\ decal\: :ref:`RID`, fade\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_size`\ (\ decal\: :ref:`RID`, size\: :ref:`Vector3`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decal_set_texture`\ (\ decal\: :ref:`RID`, type\: :ref:`DecalTexture`, texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`decals_set_filter`\ (\ filter\: :ref:`DecalFilter`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`directional_light_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`directional_shadow_atlas_set_size`\ (\ size\: :ref:`int`, is_16bits\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`directional_soft_shadow_filter_set_quality`\ (\ quality\: :ref:`ShadowQuality`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`environment_bake_panorama`\ (\ environment\: :ref:`RID`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`environment_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_glow_set_use_bicubic_upscale`\ (\ enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_adjustment`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`, use_1d_color_correction\: :ref:`bool`, color_correction\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_ambient_light`\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contribution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_background`\ (\ env\: :ref:`RID`, bg\: :ref:`EnvironmentBG`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_bg_color`\ (\ env\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_bg_energy`\ (\ env\: :ref:`RID`, multiplier\: :ref:`float`, exposure_value\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_camera_id`\ (\ env\: :ref:`RID`, id\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_canvas_max_layer`\ (\ env\: :ref:`RID`, max_layer\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_fog`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, light_color\: :ref:`Color`, light_energy\: :ref:`float`, sun_scatter\: :ref:`float`, density\: :ref:`float`, height\: :ref:`float`, height_density\: :ref:`float`, aerial_perspective\: :ref:`float`, sky_affect\: :ref:`float`, fog_mode\: :ref:`EnvironmentFogMode` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_fog_depth`\ (\ env\: :ref:`RID`, curve\: :ref:`float`, begin\: :ref:`float`, end\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_glow`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, levels\: :ref:`PackedFloat32Array`, intensity\: :ref:`float`, strength\: :ref:`float`, mix\: :ref:`float`, bloom_threshold\: :ref:`float`, blend_mode\: :ref:`EnvironmentGlowBlendMode`, hdr_bleed_threshold\: :ref:`float`, hdr_bleed_scale\: :ref:`float`, hdr_luminance_cap\: :ref:`float`, glow_map_strength\: :ref:`float`, glow_map\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sdfgi`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, cascades\: :ref:`int`, min_cell_size\: :ref:`float`, y_scale\: :ref:`EnvironmentSDFGIYScale`, use_occlusion\: :ref:`bool`, bounce_feedback\: :ref:`float`, read_sky\: :ref:`bool`, energy\: :ref:`float`, normal_bias\: :ref:`float`, probe_bias\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sdfgi_frames_to_converge`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sdfgi_frames_to_update_light`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sdfgi_ray_count`\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sky`\ (\ env\: :ref:`RID`, sky\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sky_custom_fov`\ (\ env\: :ref:`RID`, scale\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_sky_orientation`\ (\ env\: :ref:`RID`, orientation\: :ref:`Basis`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_ssao`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, radius\: :ref:`float`, intensity\: :ref:`float`, power\: :ref:`float`, detail\: :ref:`float`, horizon\: :ref:`float`, sharpness\: :ref:`float`, light_affect\: :ref:`float`, ao_channel_affect\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_ssao_quality`\ (\ quality\: :ref:`EnvironmentSSAOQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_ssil_quality`\ (\ quality\: :ref:`EnvironmentSSILQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_ssr`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, max_steps\: :ref:`int`, fade_in\: :ref:`float`, fade_out\: :ref:`float`, depth_tolerance\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_ssr_half_size`\ (\ half_size\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_ssr_roughness_quality`\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_tonemap`\ (\ env\: :ref:`RID`, tone_mapper\: :ref:`EnvironmentToneMapper`, exposure\: :ref:`float`, white\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_tonemap_agx_contrast`\ (\ env\: :ref:`RID`, agx_contrast\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_volumetric_fog`\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, density\: :ref:`float`, albedo\: :ref:`Color`, emission\: :ref:`Color`, emission_energy\: :ref:`float`, anisotropy\: :ref:`float`, length\: :ref:`float`, p_detail_spread\: :ref:`float`, gi_inject\: :ref:`float`, temporal_reprojection\: :ref:`bool`, temporal_reprojection_amount\: :ref:`float`, ambient_inject\: :ref:`float`, sky_affect\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_volumetric_fog_filter_active`\ (\ active\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`environment_set_volumetric_fog_volume_size`\ (\ size\: :ref:`int`, depth\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`fog_volume_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fog_volume_set_material`\ (\ fog_volume\: :ref:`RID`, material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fog_volume_set_shape`\ (\ fog_volume\: :ref:`RID`, shape\: :ref:`FogVolumeShape`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`fog_volume_set_size`\ (\ fog_volume\: :ref:`RID`, size\: :ref:`Vector3`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`force_draw`\ (\ swap_buffers\: :ref:`bool` = true, frame_step\: :ref:`float` = 0.0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`force_sync`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`free_rid`\ (\ rid\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_current_rendering_driver_name`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_current_rendering_method`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_default_clear_color`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_frame_setup_time_cpu`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RenderingDevice` | :ref:`get_rendering_device`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_rendering_info`\ (\ info\: :ref:`RenderingInfo`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`get_shader_parameter_list`\ (\ shader\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_test_cube`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_test_texture`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_video_adapter_api_version`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_video_adapter_name`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`DeviceType` | :ref:`get_video_adapter_type`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_video_adapter_vendor`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_white_texture`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`gi_set_use_half_resolution`\ (\ half_resolution\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`global_shader_parameter_add`\ (\ name\: :ref:`StringName`, type\: :ref:`GlobalShaderParameterType`, default_value\: :ref:`Variant`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`global_shader_parameter_get`\ (\ name\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`StringName`\] | :ref:`global_shader_parameter_get_list`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GlobalShaderParameterType` | :ref:`global_shader_parameter_get_type`\ (\ name\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`global_shader_parameter_remove`\ (\ name\: :ref:`StringName`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`global_shader_parameter_set`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`global_shader_parameter_set_override`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_changed`\ (\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_feature`\ (\ feature\: :ref:`Features`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_os_feature`\ (\ feature\: :ref:`String`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_attach_object_instance_id`\ (\ instance\: :ref:`RID`, id\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_attach_skeleton`\ (\ instance\: :ref:`RID`, skeleton\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`instance_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`instance_create2`\ (\ base\: :ref:`RID`, scenario\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter_default_value`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`instance_geometry_get_shader_parameter_list`\ (\ instance\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_cast_shadows_setting`\ (\ instance\: :ref:`RID`, shadow_casting_setting\: :ref:`ShadowCastingSetting`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_flag`\ (\ instance\: :ref:`RID`, flag\: :ref:`InstanceFlags`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_lightmap`\ (\ instance\: :ref:`RID`, lightmap\: :ref:`RID`, lightmap_uv_scale\: :ref:`Rect2`, lightmap_slice\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_lod_bias`\ (\ instance\: :ref:`RID`, lod_bias\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_material_overlay`\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_material_override`\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_shader_parameter`\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_transparency`\ (\ instance\: :ref:`RID`, transparency\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_geometry_set_visibility_range`\ (\ instance\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`, min_margin\: :ref:`float`, max_margin\: :ref:`float`, fade_mode\: :ref:`VisibilityRangeFadeMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_base`\ (\ instance\: :ref:`RID`, base\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_blend_shape_weight`\ (\ instance\: :ref:`RID`, shape\: :ref:`int`, weight\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_custom_aabb`\ (\ instance\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_extra_visibility_margin`\ (\ instance\: :ref:`RID`, margin\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_ignore_culling`\ (\ instance\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_layer_mask`\ (\ instance\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_pivot_data`\ (\ instance\: :ref:`RID`, sorting_offset\: :ref:`float`, use_aabb_center\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_scenario`\ (\ instance\: :ref:`RID`, scenario\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_surface_override_material`\ (\ instance\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_transform`\ (\ instance\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_visibility_parent`\ (\ instance\: :ref:`RID`, parent\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_set_visible`\ (\ instance\: :ref:`RID`, visible\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`instance_teleport`\ (\ instance\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_aabb`\ (\ aabb\: :ref:`AABB`, scenario\: :ref:`RID` = RID()\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_convex`\ (\ convex\: :ref:`Array`\[:ref:`Plane`\], scenario\: :ref:`RID` = RID()\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_ray`\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, scenario\: :ref:`RID` = RID()\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_on_render_thread`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_directional_set_blend_splits`\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_directional_set_shadow_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalShadowMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_directional_set_sky_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalSkyMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_omni_set_shadow_mode`\ (\ light\: :ref:`RID`, mode\: :ref:`LightOmniShadowMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_projectors_set_filter`\ (\ filter\: :ref:`LightProjectorFilter`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_bake_mode`\ (\ light\: :ref:`RID`, bake_mode\: :ref:`LightBakeMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_color`\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_cull_mask`\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_distance_fade`\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, shadow\: :ref:`float`, length\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_max_sdfgi_cascade`\ (\ light\: :ref:`RID`, cascade\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_negative`\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_param`\ (\ light\: :ref:`RID`, param\: :ref:`LightParam`, value\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_projector`\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_reverse_cull_face_mode`\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_shadow`\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`light_set_shadow_caster_mask`\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`lightmap_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_bsp_tree`\ (\ lightmap\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`lightmap_get_probe_capture_points`\ (\ lightmap\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedColorArray` | :ref:`lightmap_get_probe_capture_sh`\ (\ lightmap\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_tetrahedra`\ (\ lightmap\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`lightmap_set_baked_exposure_normalization`\ (\ lightmap\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`lightmap_set_probe_bounds`\ (\ lightmap\: :ref:`RID`, bounds\: :ref:`AABB`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`lightmap_set_probe_capture_data`\ (\ lightmap\: :ref:`RID`, points\: :ref:`PackedVector3Array`, point_sh\: :ref:`PackedColorArray`, tetrahedra\: :ref:`PackedInt32Array`, bsp_tree\: :ref:`PackedInt32Array`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`lightmap_set_probe_capture_update_speed`\ (\ speed\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`lightmap_set_probe_interior`\ (\ lightmap\: :ref:`RID`, interior\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`lightmap_set_textures`\ (\ lightmap\: :ref:`RID`, light\: :ref:`RID`, uses_sh\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`lightmaps_set_bicubic_filter`\ (\ enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`make_sphere_mesh`\ (\ latitudes\: :ref:`int`, longitudes\: :ref:`int`, radius\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`material_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`material_get_param`\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`material_set_next_pass`\ (\ material\: :ref:`RID`, next_material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`material_set_param`\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`material_set_render_priority`\ (\ material\: :ref:`RID`, priority\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`material_set_shader`\ (\ shader_material\: :ref:`RID`, shader\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`material_set_use_debanding`\ (\ enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_add_surface`\ (\ mesh\: :ref:`RID`, surface\: :ref:`Dictionary`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_add_surface_from_arrays`\ (\ mesh\: :ref:`RID`, primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array` = [], lods\: :ref:`Dictionary` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_clear`\ (\ mesh\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`mesh_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`mesh_create_from_surfaces`\ (\ surfaces\: :ref:`Array`\[:ref:`Dictionary`\], blend_shape_count\: :ref:`int` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_get_blend_shape_count`\ (\ mesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode`\ (\ mesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`mesh_get_custom_aabb`\ (\ mesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`mesh_get_surface`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_get_surface_count`\ (\ mesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_set_blend_shape_mode`\ (\ mesh\: :ref:`RID`, mode\: :ref:`BlendShapeMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_set_custom_aabb`\ (\ mesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_set_shadow_mesh`\ (\ mesh\: :ref:`RID`, shadow_mesh\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`mesh_surface_get_arrays`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Array`\] | :ref:`mesh_surface_get_blend_shape_arrays`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_attribute_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_index_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_normal_tangent_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_offset`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`, array_index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_skin_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_vertex_stride`\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`mesh_surface_get_material`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_remove`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_set_material`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_update_attribute_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_update_index_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_update_skin_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`mesh_surface_update_vertex_region`\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_allocate_data`\ (\ multimesh\: :ref:`RID`, instances\: :ref:`int`, transform_format\: :ref:`MultimeshTransformFormat`, color_format\: :ref:`bool` = false, custom_data_format\: :ref:`bool` = false, use_indirect\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`multimesh_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`multimesh_get_aabb`\ (\ multimesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat32Array` | :ref:`multimesh_get_buffer`\ (\ multimesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`multimesh_get_buffer_rd_rid`\ (\ multimesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`multimesh_get_command_buffer_rd_rid`\ (\ multimesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`multimesh_get_custom_aabb`\ (\ multimesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`multimesh_get_instance_count`\ (\ multimesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`multimesh_get_mesh`\ (\ multimesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`multimesh_get_visible_instances`\ (\ multimesh\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`multimesh_instance_get_color`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`multimesh_instance_get_custom_data`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`multimesh_instance_get_transform`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_instance_reset_physics_interpolation`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_instance_set_color`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_instance_set_custom_data`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, custom_data\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_instance_set_transform`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_instance_set_transform_2d`\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_instances_reset_physics_interpolation`\ (\ multimesh\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_set_buffer`\ (\ multimesh\: :ref:`RID`, buffer\: :ref:`PackedFloat32Array`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_set_buffer_interpolated`\ (\ multimesh\: :ref:`RID`, buffer\: :ref:`PackedFloat32Array`, buffer_previous\: :ref:`PackedFloat32Array`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_set_custom_aabb`\ (\ multimesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_set_mesh`\ (\ multimesh\: :ref:`RID`, mesh\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_set_physics_interpolated`\ (\ multimesh\: :ref:`RID`, interpolated\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_set_physics_interpolation_quality`\ (\ multimesh\: :ref:`RID`, quality\: :ref:`MultimeshPhysicsInterpolationQuality`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`multimesh_set_visible_instances`\ (\ multimesh\: :ref:`RID`, visible\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`occluder_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`occluder_set_mesh`\ (\ occluder\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`omni_light_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`particles_collision_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_height_field_update`\ (\ particles_collision\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_attractor_attenuation`\ (\ particles_collision\: :ref:`RID`, curve\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_attractor_directionality`\ (\ particles_collision\: :ref:`RID`, amount\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_attractor_strength`\ (\ particles_collision\: :ref:`RID`, strength\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_box_extents`\ (\ particles_collision\: :ref:`RID`, extents\: :ref:`Vector3`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_collision_type`\ (\ particles_collision\: :ref:`RID`, type\: :ref:`ParticlesCollisionType`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_cull_mask`\ (\ particles_collision\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_field_texture`\ (\ particles_collision\: :ref:`RID`, texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_height_field_mask`\ (\ particles_collision\: :ref:`RID`, mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_height_field_resolution`\ (\ particles_collision\: :ref:`RID`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_collision_set_sphere_radius`\ (\ particles_collision\: :ref:`RID`, radius\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`particles_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_emit`\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, emit_flags\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`particles_get_current_aabb`\ (\ particles\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`particles_get_emitting`\ (\ particles\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`particles_is_inactive`\ (\ particles\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_request_process`\ (\ particles\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_request_process_time`\ (\ particles\: :ref:`RID`, time\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_restart`\ (\ particles\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_amount`\ (\ particles\: :ref:`RID`, amount\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_amount_ratio`\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_collision_base_size`\ (\ particles\: :ref:`RID`, size\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_custom_aabb`\ (\ particles\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_draw_order`\ (\ particles\: :ref:`RID`, order\: :ref:`ParticlesDrawOrder`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_draw_pass_mesh`\ (\ particles\: :ref:`RID`, pass\: :ref:`int`, mesh\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_draw_passes`\ (\ particles\: :ref:`RID`, count\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_emission_transform`\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_emitter_velocity`\ (\ particles\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_emitting`\ (\ particles\: :ref:`RID`, emitting\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_explosiveness_ratio`\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_fixed_fps`\ (\ particles\: :ref:`RID`, fps\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_fractional_delta`\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_interp_to_end`\ (\ particles\: :ref:`RID`, factor\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_interpolate`\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_lifetime`\ (\ particles\: :ref:`RID`, lifetime\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_mode`\ (\ particles\: :ref:`RID`, mode\: :ref:`ParticlesMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_one_shot`\ (\ particles\: :ref:`RID`, one_shot\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_pre_process_time`\ (\ particles\: :ref:`RID`, time\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_process_material`\ (\ particles\: :ref:`RID`, material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_randomness_ratio`\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_speed_scale`\ (\ particles\: :ref:`RID`, scale\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_subemitter`\ (\ particles\: :ref:`RID`, subemitter_particles\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_trail_bind_poses`\ (\ particles\: :ref:`RID`, bind_poses\: :ref:`Array`\[:ref:`Transform3D`\]\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_trails`\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`, length_sec\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_transform_align`\ (\ particles\: :ref:`RID`, align\: :ref:`ParticlesTransformAlign`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`particles_set_use_local_coordinates`\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`positional_soft_shadow_filter_set_quality`\ (\ quality\: :ref:`ShadowQuality`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`reflection_probe_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_ambient_color`\ (\ probe\: :ref:`RID`, color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_ambient_energy`\ (\ probe\: :ref:`RID`, energy\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_ambient_mode`\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeAmbientMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_as_interior`\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_blend_distance`\ (\ probe\: :ref:`RID`, blend_distance\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_cull_mask`\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_enable_box_projection`\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_enable_shadows`\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_intensity`\ (\ probe\: :ref:`RID`, intensity\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_max_distance`\ (\ probe\: :ref:`RID`, distance\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_mesh_lod_threshold`\ (\ probe\: :ref:`RID`, pixels\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_origin_offset`\ (\ probe\: :ref:`RID`, offset\: :ref:`Vector3`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_reflection_mask`\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_resolution`\ (\ probe\: :ref:`RID`, resolution\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_size`\ (\ probe\: :ref:`RID`, size\: :ref:`Vector3`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reflection_probe_set_update_mode`\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeUpdateMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`request_frame_drawn_callback`\ (\ callable\: :ref:`Callable`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`scenario_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`scenario_set_camera_attributes`\ (\ scenario\: :ref:`RID`, effects\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`scenario_set_compositor`\ (\ scenario\: :ref:`RID`, compositor\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`scenario_set_environment`\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`scenario_set_fallback_environment`\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`screen_space_roughness_limiter_set_active`\ (\ enable\: :ref:`bool`, amount\: :ref:`float`, limit\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_boot_image`\ (\ image\: :ref:`Image`, color\: :ref:`Color`, scale\: :ref:`bool`, use_filter\: :ref:`bool` = true\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_boot_image_with_stretch`\ (\ image\: :ref:`Image`, color\: :ref:`Color`, stretch_mode\: :ref:`SplashStretchMode`, use_filter\: :ref:`bool` = true\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_debug_generate_wireframes`\ (\ generate\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_default_clear_color`\ (\ color\: :ref:`Color`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shader_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`shader_get_code`\ (\ shader\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shader_get_default_texture_parameter`\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`shader_get_parameter_default`\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`shader_set_code`\ (\ shader\: :ref:`RID`, code\: :ref:`String`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`shader_set_default_texture_parameter`\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, texture\: :ref:`RID`, index\: :ref:`int` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`shader_set_path_hint`\ (\ shader\: :ref:`RID`, path\: :ref:`String`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`skeleton_allocate_data`\ (\ skeleton\: :ref:`RID`, bones\: :ref:`int`, is_2d_skeleton\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`skeleton_bone_get_transform`\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d`\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`skeleton_bone_set_transform`\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform3D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`skeleton_bone_set_transform_2d`\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`skeleton_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`skeleton_get_bone_count`\ (\ skeleton\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`skeleton_set_base_transform_2d`\ (\ skeleton\: :ref:`RID`, base_transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`sky_bake_panorama`\ (\ sky\: :ref:`RID`, energy\: :ref:`float`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`sky_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`sky_set_material`\ (\ sky\: :ref:`RID`, material\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`sky_set_mode`\ (\ sky\: :ref:`RID`, mode\: :ref:`SkyMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`sky_set_radiance_size`\ (\ sky\: :ref:`RID`, radiance_size\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`spot_light_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`sub_surface_scattering_set_quality`\ (\ quality\: :ref:`SubSurfaceScatteringQuality`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`sub_surface_scattering_set_scale`\ (\ scale\: :ref:`float`, depth_scale\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_2d_create`\ (\ image\: :ref:`Image`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`texture_2d_get`\ (\ texture\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`texture_2d_layer_get`\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_2d_layered_create`\ (\ layers\: :ref:`Array`\[:ref:`Image`\], layered_type\: :ref:`TextureLayeredType`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_2d_layered_placeholder_create`\ (\ layered_type\: :ref:`TextureLayeredType`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_2d_placeholder_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`texture_2d_update`\ (\ texture\: :ref:`RID`, image\: :ref:`Image`, layer\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_3d_create`\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Image`\] | :ref:`texture_3d_get`\ (\ texture\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_3d_placeholder_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`texture_3d_update`\ (\ texture\: :ref:`RID`, data\: :ref:`Array`\[:ref:`Image`\]\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_create_from_native_handle`\ (\ type\: :ref:`TextureType`, format\: :ref:`Format`, native_handle\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int` = 1, layered_type\: :ref:`TextureLayeredType` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Format` | :ref:`texture_get_format`\ (\ texture\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`texture_get_native_handle`\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`texture_get_path`\ (\ texture\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_get_rd_texture`\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_proxy_create`\ (\ base\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`texture_proxy_update`\ (\ texture\: :ref:`RID`, proxy_to\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_rd_create`\ (\ rd_texture\: :ref:`RID`, layer_type\: :ref:`TextureLayeredType` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`texture_replace`\ (\ texture\: :ref:`RID`, by_texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`texture_set_force_redraw_if_visible`\ (\ texture\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`texture_set_path`\ (\ texture\: :ref:`RID`, path\: :ref:`String`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`texture_set_size_override`\ (\ texture\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_attach_camera`\ (\ viewport\: :ref:`RID`, camera\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_attach_canvas`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_attach_to_screen`\ (\ viewport\: :ref:`RID`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0), screen\: :ref:`int` = 0\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`viewport_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`viewport_get_measured_render_time_cpu`\ (\ viewport\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`viewport_get_measured_render_time_gpu`\ (\ viewport\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`viewport_get_render_info`\ (\ viewport\: :ref:`RID`, type\: :ref:`ViewportRenderInfoType`, info\: :ref:`ViewportRenderInfo`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`viewport_get_render_target`\ (\ viewport\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`viewport_get_texture`\ (\ viewport\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ViewportUpdateMode` | :ref:`viewport_get_update_mode`\ (\ viewport\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_remove_canvas`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_active`\ (\ viewport\: :ref:`RID`, active\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_anisotropic_filtering_level`\ (\ viewport\: :ref:`RID`, anisotropic_filtering_level\: :ref:`ViewportAnisotropicFiltering`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_canvas_cull_mask`\ (\ viewport\: :ref:`RID`, canvas_cull_mask\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_canvas_stacking`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, layer\: :ref:`int`, sublayer\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_canvas_transform`\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, offset\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_clear_mode`\ (\ viewport\: :ref:`RID`, clear_mode\: :ref:`ViewportClearMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_debug_draw`\ (\ viewport\: :ref:`RID`, draw\: :ref:`ViewportDebugDraw`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_default_canvas_item_texture_filter`\ (\ viewport\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_default_canvas_item_texture_repeat`\ (\ viewport\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_disable_2d`\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_disable_3d`\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_environment_mode`\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportEnvironmentMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_fsr_sharpness`\ (\ viewport\: :ref:`RID`, sharpness\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_global_canvas_transform`\ (\ viewport\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_measure_render_time`\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_msaa_2d`\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_msaa_3d`\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_occlusion_culling_build_quality`\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_occlusion_rays_per_thread`\ (\ rays_per_thread\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_parent_viewport`\ (\ viewport\: :ref:`RID`, parent_viewport\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision`\ (\ viewport\: :ref:`RID`, quadrant\: :ref:`int`, subdivision\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_positional_shadow_atlas_size`\ (\ viewport\: :ref:`RID`, size\: :ref:`int`, use_16_bits\: :ref:`bool` = false\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_render_direct_to_screen`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_scaling_3d_mode`\ (\ viewport\: :ref:`RID`, scaling_3d_mode\: :ref:`ViewportScaling3DMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_scaling_3d_scale`\ (\ viewport\: :ref:`RID`, scale\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_scenario`\ (\ viewport\: :ref:`RID`, scenario\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_screen_space_aa`\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportScreenSpaceAA`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_sdf_oversize_and_scale`\ (\ viewport\: :ref:`RID`, oversize\: :ref:`ViewportSDFOversize`, scale\: :ref:`ViewportSDFScale`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_size`\ (\ viewport\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_snap_2d_transforms_to_pixel`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_snap_2d_vertices_to_pixel`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_texture_mipmap_bias`\ (\ viewport\: :ref:`RID`, mipmap_bias\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_transparent_background`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_update_mode`\ (\ viewport\: :ref:`RID`, update_mode\: :ref:`ViewportUpdateMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_use_debanding`\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_use_hdr_2d`\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_use_occlusion_culling`\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_use_taa`\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_use_xr`\ (\ viewport\: :ref:`RID`, use_xr\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_vrs_mode`\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_vrs_texture`\ (\ viewport\: :ref:`RID`, texture\: :ref:`RID`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`viewport_set_vrs_update_mode`\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSUpdateMode`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`visibility_notifier_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`visibility_notifier_set_aabb`\ (\ notifier\: :ref:`RID`, aabb\: :ref:`AABB`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`visibility_notifier_set_callbacks`\ (\ notifier\: :ref:`RID`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_allocate_data`\ (\ voxel_gi\: :ref:`RID`, to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3i`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`voxel_gi_create`\ (\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`voxel_gi_get_data_cells`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`voxel_gi_get_distance_field`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`voxel_gi_get_level_counts`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`voxel_gi_get_octree_cells`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i` | :ref:`voxel_gi_get_octree_size`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`voxel_gi_get_to_cell_xform`\ (\ voxel_gi\: :ref:`RID`\ ) |const| | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_baked_exposure_normalization`\ (\ voxel_gi\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_bias`\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_dynamic_range`\ (\ voxel_gi\: :ref:`RID`, range\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_energy`\ (\ voxel_gi\: :ref:`RID`, energy\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_interior`\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_normal_bias`\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_propagation`\ (\ voxel_gi\: :ref:`RID`, amount\: :ref:`float`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_quality`\ (\ quality\: :ref:`VoxelGIQuality`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`voxel_gi_set_use_two_bounces`\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) | +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group 信号 ---- .. _class_RenderingServer_signal_frame_post_draw: .. rst-class:: classref-signal **frame_post_draw**\ (\ ) :ref:`🔗` 在该帧的结尾发出，此时 RenderingServer 刚刚完成对所有 Viewport 的更新。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_signal_frame_pre_draw: .. rst-class:: classref-signal **frame_pre_draw**\ (\ ) :ref:`🔗` 在该帧的开头发出，此后 RenderingServer 会更新所有 Viewport。 .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group 枚举 ---- .. _enum_RenderingServer_TextureType: .. rst-class:: classref-enumeration enum **TextureType**: :ref:`🔗` .. _class_RenderingServer_constant_TEXTURE_TYPE_2D: .. rst-class:: classref-enumeration-constant :ref:`TextureType` **TEXTURE_TYPE_2D** = ``0`` 2D 纹理。 .. _class_RenderingServer_constant_TEXTURE_TYPE_LAYERED: .. rst-class:: classref-enumeration-constant :ref:`TextureType` **TEXTURE_TYPE_LAYERED** = ``1`` 分层纹理。 .. _class_RenderingServer_constant_TEXTURE_TYPE_3D: .. rst-class:: classref-enumeration-constant :ref:`TextureType` **TEXTURE_TYPE_3D** = ``2`` 3D 纹理。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_TextureLayeredType: .. rst-class:: classref-enumeration enum **TextureLayeredType**: :ref:`🔗` .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY: .. rst-class:: classref-enumeration-constant :ref:`TextureLayeredType` **TEXTURE_LAYERED_2D_ARRAY** = ``0`` 二维纹理数组（见 :ref:`Texture2DArray`\ ）。 .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP: .. rst-class:: classref-enumeration-constant :ref:`TextureLayeredType` **TEXTURE_LAYERED_CUBEMAP** = ``1`` 立方体贴图纹理（见 :ref:`Cubemap`\ ）。 .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY: .. rst-class:: classref-enumeration-constant :ref:`TextureLayeredType` **TEXTURE_LAYERED_CUBEMAP_ARRAY** = ``2`` 立方体贴图纹理数组（见 :ref:`CubemapArray`\ ）。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CubeMapLayer: .. rst-class:: classref-enumeration enum **CubeMapLayer**: :ref:`🔗` .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_LEFT** = ``0`` :ref:`Cubemap` 的左面。 .. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_RIGHT** = ``1`` :ref:`Cubemap` 的右面。 .. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_BOTTOM** = ``2`` :ref:`Cubemap` 的底面。 .. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_TOP** = ``3`` :ref:`Cubemap` 的顶面。 .. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_FRONT** = ``4`` :ref:`Cubemap` 的正面。 .. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_BACK** = ``5`` :ref:`Cubemap` 的背面。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ShaderMode: .. rst-class:: classref-enumeration enum **ShaderMode**: :ref:`🔗` .. _class_RenderingServer_constant_SHADER_SPATIAL: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_SPATIAL** = ``0`` 着色器是 3D 着色器。 .. _class_RenderingServer_constant_SHADER_CANVAS_ITEM: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_CANVAS_ITEM** = ``1`` 着色器是 2D 着色器。 .. _class_RenderingServer_constant_SHADER_PARTICLES: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_PARTICLES** = ``2`` 着色器是粒子着色器（2D 和 3D 均可使用）。 .. _class_RenderingServer_constant_SHADER_SKY: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_SKY** = ``3`` 着色器是 3D 天空着色器。 .. _class_RenderingServer_constant_SHADER_FOG: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_FOG** = ``4`` 着色器是 3D 雾着色器。 .. _class_RenderingServer_constant_SHADER_MAX: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_MAX** = ``5`` 代表 :ref:`ShaderMode` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ArrayType: .. rst-class:: classref-enumeration enum **ArrayType**: :ref:`🔗` .. _class_RenderingServer_constant_ARRAY_VERTEX: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_VERTEX** = ``0`` 数组是顶点位置数组。 .. _class_RenderingServer_constant_ARRAY_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_NORMAL** = ``1`` 数组是法线数组。 .. _class_RenderingServer_constant_ARRAY_TANGENT: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_TANGENT** = ``2`` 数组是切线数组。 .. _class_RenderingServer_constant_ARRAY_COLOR: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_COLOR** = ``3`` 数组是顶点颜色数组。 .. _class_RenderingServer_constant_ARRAY_TEX_UV: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_TEX_UV** = ``4`` 数组是 UV 坐标数组。 .. _class_RenderingServer_constant_ARRAY_TEX_UV2: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_TEX_UV2** = ``5`` 数组是第二组 UV 坐标的 UV 坐标数组。 .. _class_RenderingServer_constant_ARRAY_CUSTOM0: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_CUSTOM0** = ``6`` 数组是第一组自定义数据的自定义数据数组。 .. _class_RenderingServer_constant_ARRAY_CUSTOM1: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_CUSTOM1** = ``7`` 数组是第二组自定义数据的自定义数据数组。 .. _class_RenderingServer_constant_ARRAY_CUSTOM2: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_CUSTOM2** = ``8`` 数组是第三组自定义数据的自定义数据数组。 .. _class_RenderingServer_constant_ARRAY_CUSTOM3: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_CUSTOM3** = ``9`` 数组是第四组自定义数据的自定义数据数组。 .. _class_RenderingServer_constant_ARRAY_BONES: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_BONES** = ``10`` 数组包含骨骼信息。 .. _class_RenderingServer_constant_ARRAY_WEIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_WEIGHTS** = ``11`` 数组是重量信息。 .. _class_RenderingServer_constant_ARRAY_INDEX: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_INDEX** = ``12`` 数组是索引数组。 .. _class_RenderingServer_constant_ARRAY_MAX: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_MAX** = ``13`` 代表 :ref:`ArrayType` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ArrayCustomFormat: .. rst-class:: classref-enumeration enum **ArrayCustomFormat**: :ref:`🔗` .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGBA8_UNORM** = ``0`` 自定义数据数组包含的是每通道 8 位的红、绿、蓝、Alpha 颜色数据。元素经过归一化，是 ``[0.0, 1.0]`` 范围内的无符号浮点数。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGBA8_SNORM** = ``1`` 自定义数据数组包含的是每通道 8 位的红、绿、蓝、Alpha 颜色数据。元素经过归一化，是 ``[0.0, 1.0]`` 范围内的带符号浮点数。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RG_HALF** = ``2`` 自定义数据数组包含的是每通道 16 位的红、绿、蓝颜色数据。元素为半精度浮点数。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGBA_HALF** = ``3`` 自定义数据数组包含的是每通道 16 位的红、绿、蓝、Alpha 颜色数据。元素为半精度浮点数。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_R_FLOAT** = ``4`` 自定义数据数组包含的是每通道 32 位的红色数据。元素为单精度浮点数。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RG_FLOAT** = ``5`` 自定义数据数组包含的是每通道 32 位的红、绿颜色数据。元素为单精度浮点数。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGB_FLOAT** = ``6`` 自定义数据数组包含的是每通道 32 位的红、绿、蓝颜色数据。元素为单精度浮点数。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGBA_FLOAT** = ``7`` 自定义数据数组包含的是每通道 32 位的红、绿、蓝、Alpha 颜色数据。元素为单精度浮点数。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_MAX** = ``8`` 代表 :ref:`ArrayCustomFormat` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ArrayFormat: .. rst-class:: classref-enumeration flags **ArrayFormat**: :ref:`🔗` .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_VERTEX** = ``1`` 用于标记顶点位置数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_NORMAL** = ``2`` 用于标记法线数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_TANGENT** = ``4`` 用于标记切线数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_COLOR** = ``8`` 用于标记顶点颜色数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_TEX_UV** = ``16`` 用于标记 UV 坐标数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_TEX_UV2** = ``32`` 用于标记第二个 UV 坐标的 UV 坐标数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM0** = ``64`` 用于标记第一组自定义数据的自定义顶点数据数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM1** = ``128`` 用于标记第二组自定义数据的自定义顶点数据数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM2** = ``256`` 用于标记第三组自定义数据的自定义顶点数据数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM3** = ``512`` 用于标记第四组自定义数据的自定义顶点数据数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_BONES: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_BONES** = ``1024`` 用来标记骨骼信息数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_WEIGHTS** = ``2048`` 用于标记重量数组的标记。 .. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_INDEX** = ``4096`` 用于标记索引数组的标志。 .. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_BLEND_SHAPE_MASK** = ``7`` 混合形状中允许使用的网格通道的掩码。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM_BASE** = ``13`` 第一个自定义通道的移位量。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM_BITS** = ``3`` 每个自定义通道的格式位数。请参阅 :ref:`ArrayCustomFormat`\ 。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM0_SHIFT** = ``13`` 自定义通道索引 0 需要对 :ref:`ArrayCustomFormat` 进行的按位移动量。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM1_SHIFT** = ``16`` 自定义通道索引 1 需要对 :ref:`ArrayCustomFormat` 进行的按位移动量。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM2_SHIFT** = ``19`` 自定义通道索引 2 需要对 :ref:`ArrayCustomFormat` 进行的按位移动量。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM3_SHIFT** = ``22`` 自定义通道索引 3 需要对 :ref:`ArrayCustomFormat` 进行的按位移动量。 .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM_MASK** = ``7`` 每个自定义通道的自定义格式位掩码。必须按 SHIFT 常量之一进行移位。请参阅 :ref:`ArrayCustomFormat`\ 。 .. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_COMPRESS_FLAGS_BASE** = ``25`` 第一个压缩标志的移位。压缩标志应该被传递给 :ref:`ArrayMesh.add_surface_from_arrays()` 和 :ref:`SurfaceTool.commit()`\ 。 .. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_USE_2D_VERTICES** = ``33554432`` 用于标记包含 2D 顶点的数组的标志。 .. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864`` 用于标记网格数据将在 GLES 上使用 ``GL_DYNAMIC_DRAW`` 的标志。在 Vulkan 上不使用。 .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728`` 用于标记数组使用 8 个骨骼权重而不是 4 个的标志。 .. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY** = ``268435456`` 用于标记网格没有顶点数组，而是使用索引和其他信息推断着色器中的顶点位置的标志。 .. _class_RenderingServer_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_COMPRESS_ATTRIBUTES** = ``536870912`` 用于标记网格正在使用的压缩的属性（顶点、法线、切线、UV）的标志。启用这种形式的压缩后，顶点位置将被打包到 RGBA16UNORM 属性中，并在顶点着色器中进行缩放。法线和切线将被打包到表示一个轴的 RG16UNORM 中，并在顶点的 A 通道中存储一个 16 位浮点数。UV 将使用 16 位标准化浮点数而不是完整的 32 位有符号浮点数。使用该压缩模式时，必须使用顶点、法线和切线或仅使用顶点。你无法使用没有切线的法线。如果可以的话，导入器将自动启用这种压缩。 .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_BASE: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_FORMAT_VERSION_BASE** = ``35`` 用于标记被用于存储网格版本的位的起始的标志。 .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_FORMAT_VERSION_SHIFT** = ``35`` 用于移动网格格式 int，以将版本带入最低位的标志。 .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_1: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_FORMAT_VERSION_1** = ``0`` 用于记录版本引入之前先前网格版本所使用的格式的标志。 .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_2: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_FORMAT_VERSION_2** = ``34359738368`` 用于记录第二次迭代的网格版本标志的标志。该版本与 :ref:`ARRAY_FLAG_FORMAT_VERSION_1` 之间的主要区别在于，该版本支持 :ref:`ARRAY_FLAG_COMPRESS_ATTRIBUTES`\ ，并且在该版本中，顶点位置与法线和切线去交错。 .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_CURRENT_VERSION: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_FORMAT_CURRENT_VERSION** = ``34359738368`` 用于记录引擎期望的当前版本的标志。目前这与 :ref:`ARRAY_FLAG_FORMAT_VERSION_2` 相同。 .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_MASK: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_FORMAT_VERSION_MASK** = ``255`` 使用 :ref:`ARRAY_FLAG_FORMAT_VERSION_SHIFT` 将用于网格版本的位转移到位后，用于隔离这些位的标志。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_PrimitiveType: .. rst-class:: classref-enumeration enum **PrimitiveType**: :ref:`🔗` .. _class_RenderingServer_constant_PRIMITIVE_POINTS: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_POINTS** = ``0`` 绘制的图元由点组成。 .. _class_RenderingServer_constant_PRIMITIVE_LINES: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_LINES** = ``1`` 绘制的图元由线组成。 .. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_LINE_STRIP** = ``2`` 绘制的图元由单条线带组成。 .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_TRIANGLES** = ``3`` 绘制的图元由三角形组成。 .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_TRIANGLE_STRIP** = ``4`` 绘制的图元由单条三角形带组成（最后 3 个顶点总是会构成三角形）。 .. _class_RenderingServer_constant_PRIMITIVE_MAX: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_MAX** = ``5`` 代表 :ref:`PrimitiveType` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_BlendShapeMode: .. rst-class:: classref-enumeration enum **BlendShapeMode**: :ref:`🔗` .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED: .. rst-class:: classref-enumeration-constant :ref:`BlendShapeMode` **BLEND_SHAPE_MODE_NORMALIZED** = ``0`` 混合形状是被归一化了的。 .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE: .. rst-class:: classref-enumeration-constant :ref:`BlendShapeMode` **BLEND_SHAPE_MODE_RELATIVE** = ``1`` 混合形状是相对于基础的权重。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_MultimeshTransformFormat: .. rst-class:: classref-enumeration enum **MultimeshTransformFormat**: :ref:`🔗` .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D: .. rst-class:: classref-enumeration-constant :ref:`MultimeshTransformFormat` **MULTIMESH_TRANSFORM_2D** = ``0`` 使用 :ref:`Transform2D` 存储 MultiMesh 变换。 .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D: .. rst-class:: classref-enumeration-constant :ref:`MultimeshTransformFormat` **MULTIMESH_TRANSFORM_3D** = ``1`` 使用 :ref:`Transform3D` 存储 MultiMesh 变换。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_MultimeshPhysicsInterpolationQuality: .. rst-class:: classref-enumeration enum **MultimeshPhysicsInterpolationQuality**: :ref:`🔗` .. _class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_FAST: .. rst-class:: classref-enumeration-constant :ref:`MultimeshPhysicsInterpolationQuality` **MULTIMESH_INTERP_QUALITY_FAST** = ``0`` MultiMesh 的物理插值优先考虑速度，然后才是质量。 .. _class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`MultimeshPhysicsInterpolationQuality` **MULTIMESH_INTERP_QUALITY_HIGH** = ``1`` MultiMesh 的物理插值优先考虑质量，然后才是速度。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightProjectorFilter: .. rst-class:: classref-enumeration enum **LightProjectorFilter**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_NEAREST** = ``0`` 光线投射器的最近邻过滤（用于像素风光线投射器）。渲染时不使用 mipmap，这意味着较远处的光线投射器看上去会很锐利，但会有颗粒状的图案。与使用 mipmap 的性能开销大致相同。 .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_LINEAR** = ``1`` 光线投射器的线性过滤（用于非像素风光线投射器）。渲染时不使用 mipmap，这意味着较远处的光线投射器看上去会很平滑，但会有模糊的效果。与使用 mipmap 的性能开销大致相同。 .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = ``2`` 光线投射器的最近邻过滤（用于像素风光线投射器）。渲染时使用各向同性的 mipmap，这意味着较远处的光线投射器看上去会很平滑，但会有模糊的效果。与不使用 mipmap 的性能开销大致相同。 .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = ``3`` 光线投射器的线性过滤（用于非像素风光线投射器）。渲染时使用各向同性的 mipmap，这意味着较远处的光线投射器看上去会很平滑，但会有模糊的效果。与不使用 mipmap 的性能开销大致相同。 .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4`` 光线投射器的最近邻过滤（用于像素风光线投射器）。渲染时使用各向异性的 mipmap，这意味着光线投射器从斜角度观察会既平滑又锐利。比各向同性的 mipmap 更好看，但也更慢。各向异性的级别由 :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level` 定义。 .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5`` 光线投射器的线性过滤（用于非像素风光线投射器）。渲染时使用各向异性的 mipmap，这意味着光线投射器从斜角度观察会既平滑又锐利。比各向同性的 mipmap 更好看，但也更慢。各向异性的级别由 :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level` 定义。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightType: .. rst-class:: classref-enumeration enum **LightType**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL: .. rst-class:: classref-enumeration-constant :ref:`LightType` **LIGHT_DIRECTIONAL** = ``0`` 方向（太阳/月亮）灯（见 :ref:`DirectionalLight3D`\ ）。 .. _class_RenderingServer_constant_LIGHT_OMNI: .. rst-class:: classref-enumeration-constant :ref:`LightType` **LIGHT_OMNI** = ``1`` 全向灯（见 :ref:`OmniLight3D`\ ）。 .. _class_RenderingServer_constant_LIGHT_SPOT: .. rst-class:: classref-enumeration-constant :ref:`LightType` **LIGHT_SPOT** = ``2`` 聚光灯（见 :ref:`SpotLight3D`\ ）。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightParam: .. rst-class:: classref-enumeration enum **LightParam**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_ENERGY** = ``0`` 该灯光的能量倍数。 .. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_INDIRECT_ENERGY** = ``1`` 该灯光的间接能量倍数（最终的间接能量为 :ref:`LIGHT_PARAM_ENERGY` \* :ref:`LIGHT_PARAM_INDIRECT_ENERGY`\ ）。 .. _class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY** = ``2`` 该灯光的体积雾能量倍数（最终的体积雾能量为 :ref:`LIGHT_PARAM_ENERGY` \* :ref:`LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY`\ ）。 .. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SPECULAR** = ``3`` 灯光对镜面反射的影响。 .. _class_RenderingServer_constant_LIGHT_PARAM_RANGE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_RANGE** = ``4`` 灯光的范围。 .. _class_RenderingServer_constant_LIGHT_PARAM_SIZE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SIZE** = ``5`` 使用聚光灯或全向灯时的灯光大小。使用定向光时是光的角度大小。 .. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_ATTENUATION** = ``6`` 光线的衰减。 .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SPOT_ANGLE** = ``7`` 聚光灯的角度。 .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SPOT_ATTENUATION** = ``8`` 聚光灯的衰减。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = ``9`` 阴影分割的最大距离。将这个值增大会让定向阴影在更远处可见，代价是整体的阴影细节降低和性能（因为渲染定向阴影时需要包含更多的物体）。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = ``10`` 第一次拆分所占据的阴影图集的比例。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = ``11`` 第二次拆分所占用的阴影图集的比例。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = ``12`` 第三次拆分所占用的阴影图集的比例。第四个拆分占据了其余部分。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_FADE_START** = ``13`` 阴影将开始淡出的阴影最大距离的比例。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = ``14`` 法线偏置，用于抵消物体法线的阴影查找。可以用来修复自阴影的伪影。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_BIAS** = ``15`` 对阴影查找进行偏置，从而修复自我阴影的问题。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = ``16`` 设置定向阴影压平区域的大小。压平区域会偏移阴影相机视锥体的起点，为阴影提供更高的有效深度分辨率。但是，较大的压平区大小会导致靠近视锥体边缘的大型物体的阴影出现伪影。减少压平区大小会有所帮助。将大小设置为 ``0`` 会关闭该压平效果。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_OPACITY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_OPACITY** = ``17`` 灯光的阴影不透明度。低于 ``1.0`` 的值会使光线透过阴影出现。这可以用于以较低的性能成本伪造全局照明。 .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_BLUR** = ``18`` 模糊阴影的边缘。可用于隐藏低分辨率阴影贴图中的像素伪影。较高的值会使阴影显得粗糙，并可能导致其他不需要的伪影。尽量保持接近默认值。 .. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_TRANSMITTANCE_BIAS** = ``19`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_LIGHT_PARAM_INTENSITY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_INTENSITY** = ``20`` 代表灯光强度的常量，\ :ref:`SpotLight3D` 和 :ref:`OmniLight3D` 的单位为流明，\ :ref:`DirectionalLight3D` 的单位为勒克斯。仅在 :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` 为 ``true`` 时使用。 .. _class_RenderingServer_constant_LIGHT_PARAM_MAX: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_MAX** = ``21`` 代表 :ref:`LightParam` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightBakeMode: .. rst-class:: classref-enumeration enum **LightBakeMode**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`LightBakeMode` **LIGHT_BAKE_DISABLED** = ``0`` 烘焙时灯光将被忽略。这是最快的模式，但是在烘焙全局照明时仍会考虑该灯光。该模式通常应用于快速变化的动态灯光，因为全局照明的效果在这些灯光上不太明显。 .. _class_RenderingServer_constant_LIGHT_BAKE_STATIC: .. rst-class:: classref-enumeration-constant :ref:`LightBakeMode` **LIGHT_BAKE_STATIC** = ``1`` 在静态烘焙（\ :ref:`VoxelGI`\ 、\ :ref:`LightmapGI`\ 、SDFGI（\ :ref:`Environment.sdfgi_enabled`\ ））时，考虑了灯光。灯光可以四处移动或修改，但其全局照明不会实时更新。这适用于细微的变化（例如闪烁的手电筒），但通常不适用于大的变化，例如打开和关闭灯光。 .. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC: .. rst-class:: classref-enumeration-constant :ref:`LightBakeMode` **LIGHT_BAKE_DYNAMIC** = ``2`` 动态烘焙时考虑灯光（仅 :ref:`VoxelGI` 和 SDFGI（\ :ref:`Environment.sdfgi_enabled`\ ））。灯光可以四处移动或修改，全局照明会实时更新。灯光的全局照明效果与 :ref:`LIGHT_BAKE_STATIC` 略有不同。性能开销比 :ref:`LIGHT_BAKE_STATIC` 更大。使用 SDFGI 时，动态灯光的更新速度受 :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights` 的影响。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightOmniShadowMode: .. rst-class:: classref-enumeration enum **LightOmniShadowMode**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID: .. rst-class:: classref-enumeration-constant :ref:`LightOmniShadowMode` **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = ``0`` 对全向光使用双抛物面阴影贴图。 .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE: .. rst-class:: classref-enumeration-constant :ref:`LightOmniShadowMode` **LIGHT_OMNI_SHADOW_CUBE** = ``1`` 对全向光使用立方体贴图阴影贴图。比双抛物面更慢但质量更好。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightDirectionalShadowMode: .. rst-class:: classref-enumeration enum **LightDirectionalShadowMode**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = ``0`` 对平行光使用正交阴影投影。 .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = ``1`` 使用平行光时，使用 2 个分割进行阴影投影。 .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2`` 使用平行光时，使用 4 个分割进行阴影投影。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightDirectionalSkyMode: .. rst-class:: classref-enumeration enum **LightDirectionalSkyMode**: :ref:`🔗` .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalSkyMode` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY** = ``0`` 在天空渲染和场景照明中都使用 DirectionalLight3D。 .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalSkyMode` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY** = ``1`` 仅在场景照明中使用 DirectionalLight3D。 .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalSkyMode` **LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY** = ``2`` 仅在天空渲染中使用 DirectionalLight3D。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ShadowQuality: .. rst-class:: classref-enumeration enum **ShadowQuality**: :ref:`🔗` .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_HARD** = ``0`` 最低的阴影过滤质量（最快）。使用这种质量设置时，软阴影不可用，这意味着如果 :ref:`Light3D.light_size` 和 :ref:`Light3D.light_angular_distance` 为 ``0.0``\ ，则会忽略 :ref:`Light3D.shadow_blur` 属性。 \ **注意：**\ 使用硬阴影过滤时，由 :ref:`Light3D.light_size` 和 :ref:`Light3D.light_angular_distance` 执行的可变阴影模糊仍然有效。在这种情况下\ *会*\ 考虑 :ref:`Light3D.shadow_blur`\ 。但是不会对结果进行模糊处理，而是将模糊量视为半影的最大半径。 .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_VERY_LOW** = ``1`` 非常低的阴影过滤质量（更快）。使用该质量设置时，\ :ref:`Light3D.shadow_blur` 会自动乘以 0.75 倍以避免引入过多的噪点。该划分仅适用于 :ref:`Light3D.light_size` 或 :ref:`Light3D.light_angular_distance` 为 ``0.0`` 的灯光。 .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_LOW** = ``2`` 低阴影过滤质量（快速）。 .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_MEDIUM** = ``3`` 中低阴影过滤质量（平均）。 .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_HIGH** = ``4`` 高低阴影过滤质量（慢）。使用该质量设置时，\ :ref:`Light3D.shadow_blur` 会自动乘以 1.5 倍以更好地利用高样本数。这种增加的模糊还提高了动态对象阴影的稳定性。该乘数仅适用于 :ref:`Light3D.light_size` 或 :ref:`Light3D.light_angular_distance` 为 ``0.0`` 的灯光。 .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_ULTRA** = ``5`` 最高的低阴影过滤质量（最慢）。使用该质量设置时，\ :ref:`Light3D.shadow_blur` 会自动乘以 2 倍以更好地利用高样本数。这种增加的模糊还提高了动态对象阴影的稳定性。该乘数仅适用于 :ref:`Light3D.light_size` 或 :ref:`Light3D.light_angular_distance` 为 ``0.0`` 的灯光。 .. _class_RenderingServer_constant_SHADOW_QUALITY_MAX: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_MAX** = ``6`` 代表 :ref:`ShadowQuality` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ReflectionProbeUpdateMode: .. rst-class:: classref-enumeration enum **ReflectionProbeUpdateMode**: :ref:`🔗` .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeUpdateMode` **REFLECTION_PROBE_UPDATE_ONCE** = ``0`` 反射探针将更新一次反射，然后停止。 .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeUpdateMode` **REFLECTION_PROBE_UPDATE_ALWAYS** = ``1`` 反射探针将每帧更新。这种模式对于捕捉移动物体是必要的。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ReflectionProbeAmbientMode: .. rst-class:: classref-enumeration enum **ReflectionProbeAmbientMode**: :ref:`🔗` .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeAmbientMode` **REFLECTION_PROBE_AMBIENT_DISABLED** = ``0`` 不要在反射探针的区域内应用任何环境光，区域由探针的大小决定。 .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeAmbientMode` **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = ``1`` 在反射探针的区域内应用自动来源的环境光照，区域由探针的大小决定。 .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeAmbientMode` **REFLECTION_PROBE_AMBIENT_COLOR** = ``2`` 在反射探针的区域内应用自定义环境光，区域由探针的大小决定。见 :ref:`reflection_probe_set_ambient_color()` 和 :ref:`reflection_probe_set_ambient_energy()`\ 。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_DecalTexture: .. rst-class:: classref-enumeration enum **DecalTexture**: :ref:`🔗` .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_ALBEDO** = ``0`` 贴花中的反照率纹理（\ :ref:`Decal.texture_albedo`\ ）。 .. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_NORMAL** = ``1`` 贴花中的法线贴图纹理（\ :ref:`Decal.texture_normal`\ ）。 .. _class_RenderingServer_constant_DECAL_TEXTURE_ORM: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_ORM** = ``2`` 贴花中的遮蔽/粗糙度/金属性纹理（\ :ref:`Decal.texture_orm`\ ）。 .. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_EMISSION** = ``3`` 贴花中的自发光纹理（\ :ref:`Decal.texture_orm`\ ）。 .. _class_RenderingServer_constant_DECAL_TEXTURE_MAX: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_MAX** = ``4`` 代表 :ref:`DecalTexture` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_DecalFilter: .. rst-class:: classref-enumeration enum **DecalFilter**: :ref:`🔗` .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_NEAREST** = ``0`` 贴花的最近邻过滤（用于像素风贴花）。渲染时不使用 mipmap，这意味着较远处的贴花看上去会很锐利，但会有颗粒状的图案。与使用 mipmap 的性能开销大致相同。 .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_LINEAR** = ``1`` 贴花的线性过滤（用于非像素风贴花）。渲染时不使用 mipmap，这意味着较远处的贴花看上去会很平滑，但会有模糊的效果。与使用 mipmap 的性能开销大致相同。 .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_NEAREST_MIPMAPS** = ``2`` 贴花的最近邻过滤（用于像素风贴花）。渲染时使用各向同性的 mipmap，这意味着较远处的贴花看上去会很平滑，但会有模糊的效果。与不使用 mipmap 的性能开销大致相同。 .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_LINEAR_MIPMAPS** = ``3`` 贴花的线性过滤（用于非像素风贴花）。渲染时使用各向同性的 mipmap，这意味着较远处的贴花看上去会很平滑，但会有模糊的效果。与不使用 mipmap 的性能开销大致相同。 .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4`` 贴花的最近邻过滤（用于像素风贴花）。渲染时使用各向异性的 mipmap，这意味着贴花从斜角度观察会既平滑又锐利。比各向同性的 mipmap 更好看，但也更慢。各向异性的级别由 :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level` 定义。 .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5`` 贴花的线性过滤（用于非像素风贴花）。渲染时使用各向异性的 mipmap，这意味着贴花从斜角度观察会既平滑又锐利。比各向同性的 mipmap 更好看，但也更慢。各向异性的级别由 :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level` 定义。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_VoxelGIQuality: .. rst-class:: classref-enumeration enum **VoxelGIQuality**: :ref:`🔗` .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`VoxelGIQuality` **VOXEL_GI_QUALITY_LOW** = ``0`` :ref:`VoxelGI` 较低渲染质量，使用 4 个锥体。 .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`VoxelGIQuality` **VOXEL_GI_QUALITY_HIGH** = ``1`` :ref:`VoxelGI` 较高渲染质量，使用 6 个锥体。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesMode: .. rst-class:: classref-enumeration enum **ParticlesMode**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_MODE_2D: .. rst-class:: classref-enumeration-constant :ref:`ParticlesMode` **PARTICLES_MODE_2D** = ``0`` 2D 粒子。 .. _class_RenderingServer_constant_PARTICLES_MODE_3D: .. rst-class:: classref-enumeration-constant :ref:`ParticlesMode` **PARTICLES_MODE_3D** = ``1`` 3D 粒子。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesTransformAlign: .. rst-class:: classref-enumeration enum **ParticlesTransformAlign**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ParticlesTransformAlign` **PARTICLES_TRANSFORM_ALIGN_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD: .. rst-class:: classref-enumeration-constant :ref:`ParticlesTransformAlign` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`ParticlesTransformAlign` **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`ParticlesTransformAlign` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesDrawOrder: .. rst-class:: classref-enumeration enum **ParticlesDrawOrder**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX: .. rst-class:: classref-enumeration-constant :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_INDEX** = ``0`` 按照粒子数组中出现的顺序绘制粒子。 .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME: .. rst-class:: classref-enumeration-constant :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1`` 根据粒子的寿命对其进行排序。换句话说，寿命最长的粒子被绘制在前面。 .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME: .. rst-class:: classref-enumeration-constant :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2`` 根据粒子寿命的倒数对粒子进行排序。换句话说，寿命最短的粒子被绘制在前面。 .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH: .. rst-class:: classref-enumeration-constant :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = ``3`` 根据粒子与相机的距离对其进行排序。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesCollisionType: .. rst-class:: classref-enumeration enum **ParticlesCollisionType**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution: .. rst-class:: classref-enumeration enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗` .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = ``6`` 代表 :ref:`ParticlesCollisionHeightfieldResolution` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_FogVolumeShape: .. rst-class:: classref-enumeration enum **FogVolumeShape**: :ref:`🔗` .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_ELLIPSOID** = ``0`` :ref:`FogVolume` 的形状类似于一个椭球体（拉伸的球体）。 .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_CONE** = ``1`` :ref:`FogVolume` 的形状像一个向上的圆锥体（在局部坐标中）。圆锥体的角度会自动被设置以填充大小。锥体将被调整以适合大小。旋转 :ref:`FogVolume` 节点以重新定向圆锥体。不支持通过大小进行非均匀缩放（改为缩放 :ref:`FogVolume` 节点）。 .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_CYLINDER** = ``2`` :ref:`FogVolume` 的形状将像一个直立的圆柱体（在局部坐标中）。旋转 :ref:`FogVolume` 节点以重新定向圆柱体。圆柱体将被调整以适合大小。不支持通过大小进行非均匀缩放（改为缩放 :ref:`FogVolume` 节点）。 .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_BOX** = ``3`` :ref:`FogVolume` 的形状会像一个盒子。 .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_WORLD** = ``4`` :ref:`FogVolume` 将没有形状，将覆盖整个世界并且不会被剔除。 .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_MAX** = ``5`` 代表 :ref:`FogVolumeShape` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportScaling3DMode: .. rst-class:: classref-enumeration enum **ViewportScaling3DMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0`` 对视口的 3D 缓冲区使用双线性缩放。可以使用 :ref:`Viewport.scaling_3d_scale` 设置缩放量。小于 ``1.0`` 的值将导致欠采样，而大于 ``1.0`` 的值将导致超采样。\ ``1.0`` 的值将禁用缩放。 .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1`` 对视口的 3D 缓冲区使用 AMD FidelityFX 超分辨率 1.0 放大。可以使用 :ref:`Viewport.scaling_3d_scale` 设置缩放量。小于 ``1.0`` 的值将导致使用 FSR 放大视口。不支持大于 ``1.0`` 的值，将改用双线性降采样。\ ``1.0`` 的值将禁用缩放。 .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR2: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_FSR2** = ``2`` 对视口的 3D 缓冲区使用 AMD FidelityFX 超分辨率 2.2 放大。可以使用 :ref:`Viewport.scaling_3d_scale` 设置缩放量。小于 ``1.0`` 的值将导致使用 FSR2 放大视口。不支持大于 ``1.0`` 的值，将改用双线性降采样。\ ``1.0`` 的值将使用原生分辨率下的 FSR2 作为 TAA 解决方案。 .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL** = ``3`` 对视口的 3D 缓冲区使用 MetalFX 空间放大。可以使用 :ref:`Viewport.scaling_3d_scale` 设置缩放量。小于 ``1.0`` 的值将导致使用 MetalFX 放大视口。不支持大于 ``1.0`` 的值，将改用双线性降采样。\ ``1.0`` 的值将禁用缩放。 \ **注意：**\ 仅在使用 Metal 渲染驱动时支持该缩放模式，因此该模式仅限于 macOS 和 iOS。 .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL** = ``4`` 对视口的 3D 缓冲区使用 MetalFX 时间放大。可以使用 :ref:`Viewport.scaling_3d_scale` 设置缩放量。小于 ``1.0`` 的值将导致使用 MetalFX 放大视口。不支持大于 ``1.0`` 的值，将改用双线性降采样。\ ``1.0`` 的值将以原生分辨率使用 MetalFX 作为 TAA 解决方案。 \ **注意：**\ 仅在使用 Metal 渲染驱动时支持该缩放模式，因此该模式仅限于 macOS 和 iOS。 .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_MAX** = ``5`` 代表 :ref:`ViewportScaling3DMode` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportUpdateMode: .. rst-class:: classref-enumeration enum **ViewportUpdateMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_DISABLED** = ``0`` 不要更新视口的渲染目标。 .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_ONCE** = ``1`` 更新一次视口的渲染目标，然后切换到 :ref:`VIEWPORT_UPDATE_DISABLED`\ 。 .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_WHEN_VISIBLE** = ``2`` 仅在渲染目标可见时更新视口的渲染目标。这是默认值。 .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = ``3`` 仅在其父级可见时更新视口的渲染目标。 .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_ALWAYS** = ``4`` 始终更新视口的渲染目标。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportClearMode: .. rst-class:: classref-enumeration enum **ViewportClearMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ViewportClearMode` **VIEWPORT_CLEAR_ALWAYS** = ``0`` 绘制前始终清除视口的渲染目标。 .. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER: .. rst-class:: classref-enumeration-constant :ref:`ViewportClearMode` **VIEWPORT_CLEAR_NEVER** = ``1`` 永不清除视口的渲染目标。 .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportClearMode` **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = ``2`` 在下一帧清除视口的渲染目标，然后切换到 :ref:`VIEWPORT_CLEAR_NEVER`\ 。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportEnvironmentMode: .. rst-class:: classref-enumeration enum **ViewportEnvironmentMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportEnvironmentMode` **VIEWPORT_ENVIRONMENT_DISABLED** = ``0`` 禁用在 2D 画布上渲染 3D 环境。 .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportEnvironmentMode` **VIEWPORT_ENVIRONMENT_ENABLED** = ``1`` 启用在 2D 画布上渲染 3D 环境。 .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT: .. rst-class:: classref-enumeration-constant :ref:`ViewportEnvironmentMode` **VIEWPORT_ENVIRONMENT_INHERIT** = ``2`` 从父级继承启用/禁用值。如果最顶层的父级也被设置为 :ref:`VIEWPORT_ENVIRONMENT_INHERIT`\ ，那么与 :ref:`VIEWPORT_ENVIRONMENT_ENABLED` 的行为相同。 .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportEnvironmentMode` **VIEWPORT_ENVIRONMENT_MAX** = ``3`` 代表 :ref:`ViewportEnvironmentMode` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportSDFOversize: .. rst-class:: classref-enumeration enum **ViewportSDFOversize**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = ``0`` 不使用过大的 2D 带符号距离场。遮挡器可能在接触视口边缘时消失，\ :ref:`GPUParticles3D` 碰撞也可能比预期更早地停止工作。对 GPU 的要求最低。 .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = ``1`` 2D 带符号距离场在每个方向（上、右、下、左）都覆盖超出视口大小 20% 的范围。 .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = ``2`` 2D 带符号距离场在每个方向（上、右、下、左）都覆盖超出视口大小 50% 的范围。 .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = ``3`` 2D 带符号距离场在每个方向（上、右、下、左）都覆盖超出视口大小 100% 的范围。对 GPU 的要求最高。 .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_MAX** = ``4`` 代表 :ref:`ViewportSDFOversize` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportSDFScale: .. rst-class:: classref-enumeration enum **ViewportSDFScale**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFScale` **VIEWPORT_SDF_SCALE_100_PERCENT** = ``0`` 全分辨率 2D 带符号距离场缩放。对 GPU 的要求最高。 .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFScale` **VIEWPORT_SDF_SCALE_50_PERCENT** = ``1`` 各轴半分辨率 2D 带符号距离场缩放（视口像素数的 25%）。 .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFScale` **VIEWPORT_SDF_SCALE_25_PERCENT** = ``2`` 各轴四分之一分辨率 2D 带符号距离场缩放（视口像素数的 6.25%）。对 GPU 的要求最低。 .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFScale` **VIEWPORT_SDF_SCALE_MAX** = ``3`` 代表 :ref:`ViewportSDFScale` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportMSAA: .. rst-class:: classref-enumeration enum **ViewportMSAA**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_DISABLED** = ``0`` 用于 3D 的多重采样抗锯齿被禁用。这是默认值，也是最快的设置。 .. _class_RenderingServer_constant_VIEWPORT_MSAA_2X: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_2X** = ``1`` 用于 3D 的多重采样抗锯齿，使用每个像素 2 个样本。这对性能有中等影响。 .. _class_RenderingServer_constant_VIEWPORT_MSAA_4X: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_4X** = ``2`` 用于 3D 的多重采样抗锯齿，使用每个像素 4 个样本。这对性能有较大影响。 .. _class_RenderingServer_constant_VIEWPORT_MSAA_8X: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_8X** = ``3`` 用于 3D 的多重采样抗锯齿，使用每个像素 8 个样本。这对性能有非常大的影响。可能在低端和较旧的硬件上不受支持。 .. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_MAX** = ``4`` 代表 :ref:`ViewportMSAA` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportAnisotropicFiltering: .. rst-class:: classref-enumeration enum **ViewportAnisotropicFiltering**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportAnisotropicFiltering` **VIEWPORT_ANISOTROPY_DISABLED** = ``0`` 各向异性过滤已禁用。 .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_2X: .. rst-class:: classref-enumeration-constant :ref:`ViewportAnisotropicFiltering` **VIEWPORT_ANISOTROPY_2X** = ``1`` 使用 2× 各向异性过滤。 .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_4X: .. rst-class:: classref-enumeration-constant :ref:`ViewportAnisotropicFiltering` **VIEWPORT_ANISOTROPY_4X** = ``2`` 使用 4× 各向异性过滤。这是默认值。 .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_8X: .. rst-class:: classref-enumeration-constant :ref:`ViewportAnisotropicFiltering` **VIEWPORT_ANISOTROPY_8X** = ``3`` 使用 8× 各向异性过滤。 .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_16X: .. rst-class:: classref-enumeration-constant :ref:`ViewportAnisotropicFiltering` **VIEWPORT_ANISOTROPY_16X** = ``4`` 使用 16× 各向异性过滤。 .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportAnisotropicFiltering` **VIEWPORT_ANISOTROPY_MAX** = ``5`` 代表 :ref:`ViewportAnisotropicFiltering` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportScreenSpaceAA: .. rst-class:: classref-enumeration enum **ViewportScreenSpaceAA**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = ``0`` 不要在全屏后处理中执行抗锯齿。 .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA: .. rst-class:: classref-enumeration-constant :ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_FXAA** = ``1`` 使用快速近似抗锯齿（Fast Approximate Anti-Aliasing）。FXAA 是一种流行的屏幕空间抗锯齿方法，速度很快，但会让图像变模糊，使用较低分辨率时尤为显著。1440p 和 4K 等较高分辨率下效果仍然不错。 .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_SMAA: .. rst-class:: classref-enumeration-constant :ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_SMAA** = ``2`` 使用次像素形态抗锯齿。SMAA 得到的结果可能比 FXAA 更清晰，但是性能开销会稍微高一些。 .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``3`` 代表 :ref:`ViewportScreenSpaceAA` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality: .. rst-class:: classref-enumeration enum **ViewportOcclusionCullingBuildQuality**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`ViewportOcclusionCullingBuildQuality` **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = ``0`` 较低的遮挡剔除 BVH 构建质量（由 Embree 定义）。CPU 占用最低，但剔除效率最低。 .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`ViewportOcclusionCullingBuildQuality` **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = ``1`` 中等的遮挡剔除 BVH 构建质量（由 Embree 定义）。 .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`ViewportOcclusionCullingBuildQuality` **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = ``2`` 较高的遮挡剔除 BVH 构建质量（由 Embree 定义）。CPU 占用最高，但剔除效率最高。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportRenderInfo: .. rst-class:: classref-enumeration enum **ViewportRenderInfo**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfo` **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = ``0`` 在单帧中绘制的对象的数量。 .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfo` **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1`` 在单帧中绘制的点、线、三角形的数量。 .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfo` **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2`` 此帧期间的绘制调用数。 .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfo` **VIEWPORT_RENDER_INFO_MAX** = ``3`` 代表 :ref:`ViewportRenderInfo` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportRenderInfoType: .. rst-class:: classref-enumeration enum **ViewportRenderInfoType**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfoType` **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = ``0`` 可见渲染阶段（不含阴影）。 .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfoType` **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = ``1`` 阴影渲染阶段。根据开启了阴影的灯光数以及方向阴影的拆分数，同一个对象可能会渲染多次。 .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_CANVAS: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfoType` **VIEWPORT_RENDER_INFO_TYPE_CANVAS** = ``2`` 画布项渲染。包括所有 2D 渲染。 .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfoType` **VIEWPORT_RENDER_INFO_TYPE_MAX** = ``3`` 代表 :ref:`ViewportRenderInfoType` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportDebugDraw: .. rst-class:: classref-enumeration enum **ViewportDebugDraw**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_DISABLED** = ``0`` 调试绘制被禁用。默认设置。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_UNSHADED** = ``1`` 显示的对象没有光照信息。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2`` 对象只使用光照信息显示。 \ **注意：**\ 使用该调试绘图模式时，场景中的所有材质都会暂时使用调试材质，因此会忽略自定义着色器。这意味着使用该调试绘图模式时，自定义着色器函数的结果（例如顶点位移）不再可见。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_OVERDRAW** = ``3`` 对象通过加法混合显示为半透明，因此可以看到它们在彼此之上绘制的位置。更高的过度绘制（由更亮的颜色表示）意味着在绘制隐藏在其他像素后面的像素时浪费了性能。 \ **注意：**\ 使用该调试绘图模式时，场景中的所有材质都会暂时使用调试材质，因此会忽略自定义着色器。这意味着使用该调试绘图模式时，自定义着色器函数的结果（例如顶点位移）不再可见。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_WIREFRAME** = ``4`` 调试绘制以线框形式绘制对象。 \ **注意：**\ 使用 Compatibility 渲染器时，必须在加载任何网格之前调用 :ref:`set_debug_generate_wireframes()` 线框才可见。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = ``5`` 绘制法线缓冲区而不是常规场景，因此可以看到将由后处理效果使用的每像素法线。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6`` 对象只使用 :ref:`VoxelGI` 中的反照率值显示。要求至少存在一个可见且已烘焙的 :ref:`VoxelGI` 节点，才能有可见的效果。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7`` 对象只使用 :ref:`VoxelGI` 中的光照值显示。要求至少存在一个可见且已烘焙的 :ref:`VoxelGI` 节点，才能有可见的效果。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8`` 对象只使用 :ref:`VoxelGI` 中的发光颜色显示。要求至少存在一个可见且已烘焙的 :ref:`VoxelGI` 节点，才能有可见的效果。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = ``9`` 在 :ref:`Viewport` 的左上象限中绘制存储来自 :ref:`OmniLight3D` 和 :ref:`SpotLight3D` 的阴影的阴影图集。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10`` 绘制阴影图集，该阴影图集存储 :ref:`Viewport` 左上象限中 :ref:`DirectionalLight3D` 的阴影。 与阴影贴图级联相关的相机视锥体切片被叠加以可视化覆盖范围。每个切片的颜色与 :ref:`VIEWPORT_DEBUG_DRAW_PSSM_SPLITS` 使用的颜色匹配。当混合阴影级联时，绘制视锥体切片时会考虑重叠。 最后一个级联显示了所有视锥体切片，以说明所有切片的覆盖范围。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = ``11`` 绘制估计的场景亮度。这是一个 1×1 的纹理，启用自动曝光时生成，用于控制场景的曝光。 \ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SSAO** = ``12`` 绘制屏幕空间环境光遮蔽纹理而不是场景，以便可以清楚地看到它是如何影响对象的。为了使这种显示模式起作用，必须在 :ref:`WorldEnvironment` 中设置 :ref:`Environment.ssao_enabled`\ 。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SSIL** = ``13`` 绘制屏幕空间间接照明纹理而不是场景，以便可以清楚地看到它是如何影响对象的。为了使这种显示模式起作用，必须在 :ref:`WorldEnvironment` 中设置 :ref:`Environment.ssil_enabled`\ 。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14`` 将场景中 :ref:`DirectionalLight3D` 的各个 PSSM 拆分用不同的颜色着色，便于查看拆分的位置。着色（按照距离相机由近到远）的顺序为红、绿、蓝、黄。 \ **注意：**\ 使用该调试绘图模式时，场景中的所有材质都会暂时使用调试材质，因此会忽略自定义着色器。这意味着使用该调试绘图模式时，自定义着色器函数的结果（例如顶点位移）不再可见。 \ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = ``15`` 绘制贴花图集，图集中保存的是各个 :ref:`Decal` 中的贴花纹理。 \ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SDFGI** = ``16`` 绘制 SDFGI 级联数据。这是用于反弹灯光、创建反射的数据结构。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = ``17`` Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene. 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. \ **Note:** Only supported when using the Forward+ rendering method. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18`` 绘制 :ref:`VoxelGI` 或 SDFGI 的全局光照缓冲。需要启用 :ref:`VoxelGI`\ （至少存在一个可见且已烘焙的 VoxelGI 节点）或 SDFGI（\ :ref:`Environment.sdfgi_enabled`\ ）才能有可见的效果。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = ``19`` 禁用网格 LOD。所有网格都会使用完整细节绘制，可以用来比较性能。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20`` 绘制 :ref:`OmniLight3D` 集群。集群决定屏幕空间中灯光的放置位置，能够让引擎在进行光照时仅对屏幕的部分区域进行处理。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21`` 绘制 :ref:`SpotLight3D` 集群。集群决定屏幕空间中灯光的放置位置，能够让引擎在进行光照时仅对屏幕的部分区域进行处理。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = ``22`` 绘制 :ref:`Decal` 集群。集群决定屏幕空间中贴花的放置位置，能够让引擎在进行贴花时仅对屏幕的部分区域进行处理。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23`` 绘制 :ref:`ReflectionProbe` 集群。集群决定屏幕空间中反射探针的放置位置，能够让引擎在处理反射探针时仅对屏幕的部分区域进行处理。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = ``24`` 绘制遮挡剔除缓冲。这个低分辨率遮挡剔除缓冲在 CPU 栅格化，可用于检查实例是否被其他对象遮挡。 \ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_MOTION_VECTORS** = ``25`` 绘制运动向量缓冲。由时间抗锯齿使用，能够修正在游戏过程中发生的运动。 \ **注意：**\ 仅在使用 Forward+ 渲染方法时支持。 .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER** = ``26`` 绘制内部缓冲区而不是常规场景，因此可以看到将被后期处理效果使用的每像素输出。 \ **注意：**\ 仅在使用 Forward+ 或 Mobile 渲染方法时支持。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportVRSMode: .. rst-class:: classref-enumeration enum **ViewportVRSMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSMode` **VIEWPORT_VRS_DISABLED** = ``0`` 可变速率着色已禁用。 .. _class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSMode` **VIEWPORT_VRS_TEXTURE** = ``1`` 可变速率着色使用纹理。请注意，对于立体视觉，请使用为每个视图提供纹理的纹理图集。 .. _class_RenderingServer_constant_VIEWPORT_VRS_XR: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSMode` **VIEWPORT_VRS_XR** = ``2`` 可变速率着色纹理由主 :ref:`XRInterface` 提供。请注意，这可能会覆盖更新模式。 .. _class_RenderingServer_constant_VIEWPORT_VRS_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSMode` **VIEWPORT_VRS_MAX** = ``3`` 代表 :ref:`ViewportVRSMode` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportVRSUpdateMode: .. rst-class:: classref-enumeration enum **ViewportVRSUpdateMode**: :ref:`🔗` .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSUpdateMode` **VIEWPORT_VRS_UPDATE_DISABLED** = ``0`` 可变速率着色的输入纹理将不会被处理。 .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ONCE: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSUpdateMode` **VIEWPORT_VRS_UPDATE_ONCE** = ``1`` 可变速率着色的输入纹理将被处理一次。 .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSUpdateMode` **VIEWPORT_VRS_UPDATE_ALWAYS** = ``2`` 可变速率着色的输入纹理将每帧进行处理。 .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSUpdateMode` **VIEWPORT_VRS_UPDATE_MAX** = ``3`` 代表 :ref:`ViewportVRSUpdateMode` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_SkyMode: .. rst-class:: classref-enumeration enum **SkyMode**: :ref:`🔗` .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC: .. rst-class:: classref-enumeration-constant :ref:`SkyMode` **SKY_MODE_AUTOMATIC** = ``0`` 根据天空着色器自动选择合适的处理模式。如果着色器使用 ``TIME`` 或 ``POSITION``\ ，则会使用 :ref:`SKY_MODE_REALTIME`\ 。如果着色器使用任何 ``LIGHT_*`` 变量或任何自定义 uniform，则会使用 :ref:`SKY_MODE_INCREMENTAL`\ 。否则默认为 :ref:`SKY_MODE_QUALITY`\ 。 .. _class_RenderingServer_constant_SKY_MODE_QUALITY: .. rst-class:: classref-enumeration-constant :ref:`SkyMode` **SKY_MODE_QUALITY** = ``1`` 使用高质量重要性采样处理辐射率贴图。得到的结果通常比 :ref:`SKY_MODE_REALTIME` 的质量更高，但需要花费更多的时间来生成。如果你计划在运行时修改天空，则不应使用。如果你发现反射不够模糊，出现了火花或者萤火虫，请尝试增大 :ref:`ProjectSettings.rendering/reflections/sky_reflections/ggx_samples`\ 。 .. _class_RenderingServer_constant_SKY_MODE_INCREMENTAL: .. rst-class:: classref-enumeration-constant :ref:`SkyMode` **SKY_MODE_INCREMENTAL** = ``2`` 使用与 :ref:`SKY_MODE_QUALITY` 相同的高质量重要性采样来处理辐射率贴图，但更新会占用若干帧。帧数由 :ref:`ProjectSettings.rendering/reflections/sky_reflections/roughness_layers` 决定。当需要最高质量的辐射率贴图，但天空更新缓慢时，请使用该选项。 .. _class_RenderingServer_constant_SKY_MODE_REALTIME: .. rst-class:: classref-enumeration-constant :ref:`SkyMode` **SKY_MODE_REALTIME** = ``3`` 使用快速过滤算法处理辐射率贴图。一般来说，这会导致质量降低，但运行时间会大大加快。如果需要更好的质量，但仍需要每帧更新天空，请考虑开启 :ref:`ProjectSettings.rendering/reflections/sky_reflections/fast_filter_high_quality`\ 。 \ **注意：**\ 快速过滤算法被限制为 256x256 立方体贴图，因此 :ref:`sky_set_radiance_size()` 必须被设置为 ``256``\ 。否则会打印警告并忽略对辐射率大小的覆盖。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CompositorEffectFlags: .. rst-class:: classref-enumeration enum **CompositorEffectFlags**: :ref:`🔗` .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR** = ``1`` 启用 MSAA 时，渲染效果需要解析颜色缓冲。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH** = ``2`` 启用 MSAA 时，渲染效果需要解析深度缓冲。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS** = ``4`` 渲染效果需要生成运动向量。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS** = ``8`` 渲染效果需要生成法线和粗糙度 G 缓冲（仅适用于 Forward+）。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectFlags` **COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR** = ``16`` 渲染效果需要单独的镜面反射数据（仅适用于 Forward+）。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CompositorEffectCallbackType: .. rst-class:: classref-enumeration enum **CompositorEffectCallbackType**: :ref:`🔗` .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE** = ``0`` 回调在不透明渲染阶段之前调用，但在深度前置阶段之后（如果适用）。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE** = ``1`` 回调在不透明渲染阶段之后调用，但在渲染天空之前。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY** = ``2`` 回调在渲染天空之后调用，但在创建后台缓冲之前（如果启用，则在次表面散射和/或屏幕空间反射之前）。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT** = ``3`` 回调在透明渲染阶段之前调用，但在渲染天空和创建后台缓冲区之后。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT** = ``4`` 回调在透明渲染阶段之后调用，但在内置后期效果和输出到渲染目标之前。 .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY: .. rst-class:: classref-enumeration-constant :ref:`CompositorEffectCallbackType` **COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY** = ``-1`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentBG: .. rst-class:: classref-enumeration enum **EnvironmentBG**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_CLEAR_COLOR** = ``0`` 用透明的颜色作为背景。 .. _class_RenderingServer_constant_ENV_BG_COLOR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_COLOR** = ``1`` 使用指定的颜色作为背景。 .. _class_RenderingServer_constant_ENV_BG_SKY: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_SKY** = ``2`` 使用天空资源作为背景。 .. _class_RenderingServer_constant_ENV_BG_CANVAS: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_CANVAS** = ``3`` 使用一个指定的画布层作为背景。这对在 3D 世界中实例化一个 2D 场景很有用。 .. _class_RenderingServer_constant_ENV_BG_KEEP: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_KEEP** = ``4`` 不要清除背景，使用上一帧渲染的东西作为背景。 .. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_CAMERA_FEED** = ``5`` 在背景中显示相机源。 .. _class_RenderingServer_constant_ENV_BG_MAX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_MAX** = ``6`` 代表 :ref:`EnvironmentBG` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentAmbientSource: .. rst-class:: classref-enumeration enum **EnvironmentAmbientSource**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentAmbientSource` **ENV_AMBIENT_SOURCE_BG** = ``0`` 从指定为背景的任何来源收集环境光。 .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentAmbientSource` **ENV_AMBIENT_SOURCE_DISABLED** = ``1`` 禁用环境光。 .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentAmbientSource` **ENV_AMBIENT_SOURCE_COLOR** = ``2`` 为环境光指定特定的 :ref:`Color`\ 。 .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentAmbientSource` **ENV_AMBIENT_SOURCE_SKY** = ``3`` 无论背景如何，都从 :ref:`Sky` 收集环境光。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentReflectionSource: .. rst-class:: classref-enumeration enum **EnvironmentReflectionSource**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentReflectionSource` **ENV_REFLECTION_SOURCE_BG** = ``0`` 使用背景进行反射。 .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentReflectionSource` **ENV_REFLECTION_SOURCE_DISABLED** = ``1`` 禁用反射。 .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentReflectionSource` **ENV_REFLECTION_SOURCE_SKY** = ``2`` 无论背景如何，都使用 :ref:`Sky` 进行反射。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentGlowBlendMode: .. rst-class:: classref-enumeration enum **EnvironmentGlowBlendMode**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **ENV_GLOW_BLEND_MODE_ADDITIVE** = ``0`` 添加辉光混合模式。主要用于粒子、辉光（泛光）、镜头眩光、亮源。 .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **ENV_GLOW_BLEND_MODE_SCREEN** = ``1`` 滤色辉光混合模式。增加亮度，经常与泛光一起使用。 .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = ``2`` 柔光辉光混合模式。修改对比度，曝光阴影和高光（高质量泛光）。 .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **ENV_GLOW_BLEND_MODE_REPLACE** = ``3`` 替换辉光混合模式。用辉光值替换所有像素的颜色。这可以通过调整辉光参数来模拟全屏模糊效果，使其与原始图像的亮度相匹配。 .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **ENV_GLOW_BLEND_MODE_MIX** = ``4`` 将辉光与底层颜色混合，以避免在保持辉光效果的同时，尽可能多地增加亮度。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentFogMode: .. rst-class:: classref-enumeration enum **EnvironmentFogMode**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_FOG_MODE_EXPONENTIAL: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentFogMode` **ENV_FOG_MODE_EXPONENTIAL** = ``0`` 使用主要由雾密度定义的基于物理的雾模型。 .. _class_RenderingServer_constant_ENV_FOG_MODE_DEPTH: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentFogMode` **ENV_FOG_MODE_DEPTH** = ``1`` 使用由开始位置和结束位置以及自定义曲线定义的简单雾模型。虽然在物理上并不准确，但当你需要更多的艺术控制时，该模型可能会很有用。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentToneMapper: .. rst-class:: classref-enumeration enum **EnvironmentToneMapper**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_LINEAR** = ``0`` 不修改颜色数据，得到线性的色调映射曲线，裁剪较亮的值时不自然，明亮的光照会过曝。这是最简单快速的色调映射器。 .. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_REINHARD** = ``1`` 一种简单的色调映射曲线，会通过降低亮度值来防止发生裁剪。这会导致图像看起来平淡并且对比度低。比 :ref:`ENV_TONE_MAPPER_LINEAR` 更慢。 \ **注意：**\ 当 :ref:`Environment.tonemap_white` 保持默认值 ``1.0`` 时，\ :ref:`ENV_TONE_MAPPER_REINHARD` 生成的图像与 :ref:`ENV_TONE_MAPPER_LINEAR` 相同。 .. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_FILMIC** = ``2`` 使用类似胶卷的色调映射曲线来防止裁剪亮度值，提供比 :ref:`ENV_TONE_MAPPER_REINHARD` 更好的对比度。比 :ref:`ENV_TONE_MAPPER_REINHARD` 稍慢。 .. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_ACES** = ``3`` 使用高对比度的类似胶卷的色调映射曲线并对亮度值进行去饱和处理，从而获得更真实的外观。比 :ref:`ENV_TONE_MAPPER_FILMIC` 稍慢。 \ **注意：**\ 在 Godot 3.x 中将该色调映射运算称为“ACES Fitted”。 .. _class_RenderingServer_constant_ENV_TONE_MAPPER_AGX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_AGX** = ``4`` Uses an adjustable film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSSRRoughnessQuality: .. rst-class:: classref-enumeration enum **EnvironmentSSRRoughnessQuality**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSRRoughnessQuality` **ENV_SSR_ROUGHNESS_QUALITY_DISABLED** = ``0`` 用于屏幕空间反射的最低质量粗糙度过滤。与光滑（非粗糙）材质相比，粗糙材质不会有更模糊的屏幕空间反射。这是最快的选项。 .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSRRoughnessQuality` **ENV_SSR_ROUGHNESS_QUALITY_LOW** = ``1`` 屏幕空间反射的较低质量粗糙度过滤器。 .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSRRoughnessQuality` **ENV_SSR_ROUGHNESS_QUALITY_MEDIUM** = ``2`` 屏幕空间反射的中等质量粗糙度过滤器。 .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSRRoughnessQuality` **ENV_SSR_ROUGHNESS_QUALITY_HIGH** = ``3`` 屏幕空间反射的较高质量粗糙度过滤器。这是最慢的选项。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSSAOQuality: .. rst-class:: classref-enumeration enum **EnvironmentSSAOQuality**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_VERY_LOW** = ``0`` 最低质量的屏幕空间环境光遮蔽。 .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_LOW** = ``1`` 低质量的屏幕空间环境光遮蔽。 .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_MEDIUM** = ``2`` 中等质量的屏幕空间环境光遮蔽。 .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_HIGH** = ``3`` 高质量的屏幕空间环境光遮蔽。 .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_ULTRA** = ``4`` 最高质量的屏幕空间环境光遮蔽。使用可动态调整的自适应目标设置，以平滑地平衡性能和视觉质量。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSSILQuality: .. rst-class:: classref-enumeration enum **EnvironmentSSILQuality**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_VERY_LOW** = ``0`` 最低质量的屏幕空间间接光照。 .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_LOW** = ``1`` 较低质量的屏幕空间间接光照。 .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_MEDIUM** = ``2`` 较高质量的屏幕空间间接光照。 .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_HIGH** = ``3`` 较高质量的屏幕空间间接光照。 .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_ULTRA** = ``4`` 最高质量的屏幕空间间接光照。使用可动态调整的自适应目标设置，以平滑地平衡性能和视觉质量。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSDFGIYScale: .. rst-class:: classref-enumeration enum **EnvironmentSDFGIYScale**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIYScale` **ENV_SDFGI_Y_SCALE_50_PERCENT** = ``0`` 在 Y（垂直）轴上对 SDFGI 使用 50% 的缩放。SDFGI 单元格将比它们的宽度短两倍。这允许提供更多的 GI 细节，并减少薄地板和天花板的漏光。这通常是垂直度不高的场景的最佳选择。 .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIYScale` **ENV_SDFGI_Y_SCALE_75_PERCENT** = ``1`` 在 Y（垂直）轴上为 SDFGI 使用 75% 的缩放。这是 50% 和 100% SDFGI Y 缩放之间的平衡。 .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIYScale` **ENV_SDFGI_Y_SCALE_100_PERCENT** = ``2`` 在 Y（垂直）轴上为 SDFGI 使用 100% 的缩放。SDFGI 单元格将与宽度一样高。这通常是高度垂直场景的最佳选择。不利之处在于，薄地板和天花板可能会导致漏光更加明显。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSDFGIRayCount: .. rst-class:: classref-enumeration enum **EnvironmentSDFGIRayCount**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_4** = ``0`` 聚合 SDFGI 时每帧发出 4 条光线。对 GPU 的要求最低，但结果中噪点最多。 .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_8** = ``1`` 聚合 SDFGI 时每帧发出 8 条光线。 .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_16** = ``2`` 聚合 SDFGI 时每帧发出 16 条光线。 .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_32** = ``3`` 聚合 SDFGI 时每帧发出 32 条光线。 .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_64** = ``4`` 聚合 SDFGI 时每帧发出 64 条光线。 .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_96** = ``5`` 聚合 SDFGI 时每帧发出 96 条光线。对 GPU 的要求较高。 .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_128** = ``6`` 聚合 SDFGI 时每帧发出 128 条光线。对 GPU 的要求非常高，但结果中噪点最少。 .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_MAX** = ``7`` 代表 :ref:`EnvironmentSDFGIRayCount` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge: .. rst-class:: classref-enumeration enum **EnvironmentSDFGIFramesToConverge**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = ``0`` 通过 5 帧聚合 SDFGI。响应最快，但光线数量一定时，结果中噪点最多。 .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = ``1`` 让 SDFGI 通过 10 帧完成聚合。 .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = ``2`` 让 SDFGI 通过 15 帧完成聚合。 .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = ``3`` 让 SDFGI 通过 20 帧完成聚合。 .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = ``4`` 让 SDFGI 通过 25 帧完成聚合。 .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = ``5`` 让 SDFGI 通过 30 帧完成聚合。响应最慢，但光线数量一定时，结果中噪点最少。 .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_MAX** = ``6`` 代表 :ref:`EnvironmentSDFGIFramesToConverge` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight: .. rst-class:: classref-enumeration enum **EnvironmentSDFGIFramesToUpdateLight**: :ref:`🔗` .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = ``0`` 通过 1 帧更新 SDFGI 中动态灯光的间接光照。响应最快，但对 GPU 的要求最高。 .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = ``1`` 通过 2 帧更新 SDFGI 中动态灯光的间接光照。 .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = ``2`` 通过 4 帧更新 SDFGI 中动态灯光的间接光照。 .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = ``3`` 通过 8 帧更新 SDFGI 中动态灯光的间接光照。 .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = ``4`` 通过 16 帧更新 SDFGI 中动态灯光的间接光照。响应最慢，但对 GPU 的要求最低。 .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_MAX** = ``5`` 代表 :ref:`EnvironmentSDFGIFramesToUpdateLight` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_SubSurfaceScatteringQuality: .. rst-class:: classref-enumeration enum **SubSurfaceScatteringQuality**: :ref:`🔗` .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`SubSurfaceScatteringQuality` **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = ``0`` 完全禁用次表面散射，即便材质的 :ref:`BaseMaterial3D.subsurf_scatter_enabled` 为 ``true``\ 。对 GPU 的要求最低。 .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`SubSurfaceScatteringQuality` **SUB_SURFACE_SCATTERING_QUALITY_LOW** = ``1`` 较低质量的次表面散射。 .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`SubSurfaceScatteringQuality` **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = ``2`` 中等质量的次表面散射。 .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`SubSurfaceScatteringQuality` **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = ``3`` 较高质量的次表面散射。对 GPU 的要求最高。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_DOFBokehShape: .. rst-class:: classref-enumeration enum **DOFBokehShape**: :ref:`🔗` .. _class_RenderingServer_constant_DOF_BOKEH_BOX: .. rst-class:: classref-enumeration-constant :ref:`DOFBokehShape` **DOF_BOKEH_BOX** = ``0`` 使用一个盒式过滤计算 DOF 模糊。最快的选项，但会在模糊图案中产生明显的线条。 .. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON: .. rst-class:: classref-enumeration-constant :ref:`DOFBokehShape` **DOF_BOKEH_HEXAGON** = ``1`` 使用一个六边形过滤计算 DOF 模糊。 .. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE: .. rst-class:: classref-enumeration-constant :ref:`DOFBokehShape` **DOF_BOKEH_CIRCLE** = ``2`` 使用一个圆形过滤计算 DOF 模糊。最好的质量和最真实的，但最慢的。仅用于可以将大量性能专用于后期处理的区域（例如过场动画）。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_DOFBlurQuality: .. rst-class:: classref-enumeration enum **DOFBlurQuality**: :ref:`🔗` .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW: .. rst-class:: classref-enumeration-constant :ref:`DOFBlurQuality` **DOF_BLUR_QUALITY_VERY_LOW** = ``0`` 最低质量的 DOF 模糊。这是最快的设置，但你可能会看到不自然的过滤。 .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`DOFBlurQuality` **DOF_BLUR_QUALITY_LOW** = ``1`` 较低质量的 DOF 模糊。 .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`DOFBlurQuality` **DOF_BLUR_QUALITY_MEDIUM** = ``2`` 中等质量的 DOF 模糊。 .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`DOFBlurQuality` **DOF_BLUR_QUALITY_HIGH** = ``3`` 最高质量的 DOF 模糊。通过采集最多的样本，产生最平滑的模糊效果，但速度也明显变慢。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_InstanceType: .. rst-class:: classref-enumeration enum **InstanceType**: :ref:`🔗` .. _class_RenderingServer_constant_INSTANCE_NONE: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_NONE** = ``0`` 实例没有类型。 .. _class_RenderingServer_constant_INSTANCE_MESH: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_MESH** = ``1`` 该实例是网格。 .. _class_RenderingServer_constant_INSTANCE_MULTIMESH: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_MULTIMESH** = ``2`` 该实例是一个 multimesh。 .. _class_RenderingServer_constant_INSTANCE_PARTICLES: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_PARTICLES** = ``3`` 该实例是粒子发射器。 .. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_PARTICLES_COLLISION** = ``4`` 该实例是 GPUParticles 碰撞形状。 .. _class_RenderingServer_constant_INSTANCE_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_LIGHT** = ``5`` 该实例是灯。 .. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_REFLECTION_PROBE** = ``6`` 该实例是反射探针。 .. _class_RenderingServer_constant_INSTANCE_DECAL: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_DECAL** = ``7`` 该实例是贴花。 .. _class_RenderingServer_constant_INSTANCE_VOXEL_GI: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_VOXEL_GI** = ``8`` 该实例是 VoxelGI。 .. _class_RenderingServer_constant_INSTANCE_LIGHTMAP: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_LIGHTMAP** = ``9`` 该实例是光照贴图。 .. _class_RenderingServer_constant_INSTANCE_OCCLUDER: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_OCCLUDER** = ``10`` 该实例是遮挡剔除遮挡器。 .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_VISIBLITY_NOTIFIER** = ``11`` 该实例是屏幕可见通知器。 .. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_FOG_VOLUME** = ``12`` 该实例是雾体积。 .. _class_RenderingServer_constant_INSTANCE_MAX: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_MAX** = ``13`` 代表 :ref:`InstanceType` 枚举的大小。 .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_GEOMETRY_MASK** = ``14`` 几何体实例（网格、多网格、即时和粒子）的标志的组合。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_InstanceFlags: .. rst-class:: classref-enumeration enum **InstanceFlags**: :ref:`🔗` .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_USE_BAKED_LIGHT** = ``0`` 允许在烘焙照明中使用实例。 .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_USE_DYNAMIC_GI** = ``1`` 允许在动态全局光照中使用该实例。 .. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = ``2`` 当设置时，手动请求在下一帧绘制几何图形。 .. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = ``3`` 始终绘制，即便实例能够被遮挡剔除剔除。不影响视锥剔除。 .. _class_RenderingServer_constant_INSTANCE_FLAG_MAX: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_MAX** = ``4`` 代表 :ref:`InstanceFlags` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ShadowCastingSetting: .. rst-class:: classref-enumeration enum **ShadowCastingSetting**: :ref:`🔗` .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_OFF** = ``0`` 禁用这个实例的阴影。 .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_ON** = ``1`` 从此实例投下阴影。 .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = ``2`` 在渲染对象的阴影时禁用背面剔除。这会稍微慢一些，但可能会产生更正确的阴影。 .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3`` 仅渲染对象的阴影。对象本身不会被绘制。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_VisibilityRangeFadeMode: .. rst-class:: classref-enumeration enum **VisibilityRangeFadeMode**: :ref:`🔗` .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_DISABLED** = ``0`` 禁用给定实例的可见性范围淡出。 .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_SELF** = ``1`` 当给定实例接近其可见范围限制时淡出该给定实例。 .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2`` 当达到其可见性范围限制时淡入给定实例的依赖项。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_BakeChannels: .. rst-class:: classref-enumeration enum **BakeChannels**: :ref:`🔗` .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA: .. rst-class:: classref-enumeration-constant :ref:`BakeChannels` **BAKE_CHANNEL_ALBEDO_ALPHA** = ``0`` :ref:`bake_render_uv2()` 返回的 :ref:`Image` 数组中 :ref:`Image` 的索引。图像使用 :ref:`Image.FORMAT_RGBA8` 格式，并在 ``.rgb`` 通道中包含反照率颜色，在 ``.a`` 通道中包含 Alpha。 .. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`BakeChannels` **BAKE_CHANNEL_NORMAL** = ``1`` :ref:`bake_render_uv2()` 返回的 :ref:`Image` 数组中 :ref:`Image` 的索引。图像使用 :ref:`Image.FORMAT_RGBA8` 格式，并在 ``.rgb`` 通道中包含该对象的每像素法线，在 ``.a`` 通道中不包含任何内容。每像素法线被编码为 ``normal * 0.5 + 0.5``\ 。 .. _class_RenderingServer_constant_BAKE_CHANNEL_ORM: .. rst-class:: classref-enumeration-constant :ref:`BakeChannels` **BAKE_CHANNEL_ORM** = ``2`` :ref:`bake_render_uv2()` 返回的 :ref:`Image` 数组中 :ref:`Image` 的索引。图像使用 :ref:`Image.FORMAT_RGBA8` 格式，并在 ``.r`` 通道中包含环境光遮挡（仅来自材质和贴花），在 ``.g`` 通道中包含粗糙度，在 ``.b`` 通道中包含金属度，并且中 ``.a`` 通道中包含次表面散射量。 .. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION: .. rst-class:: classref-enumeration-constant :ref:`BakeChannels` **BAKE_CHANNEL_EMISSION** = ``3`` :ref:`bake_render_uv2()` 返回的 :ref:`Image` 数组中 :ref:`Image` 的索引。图像使用 :ref:`Image.FORMAT_RGBAH` 格式，并在 ``.rgb`` 通道中包含自发光颜色，在 ``.a`` 通道中不包含任何内容。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasTextureChannel: .. rst-class:: classref-enumeration enum **CanvasTextureChannel**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE: .. rst-class:: classref-enumeration-constant :ref:`CanvasTextureChannel` **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = ``0`` 漫反射画布纹理（\ :ref:`CanvasTexture.diffuse_texture`\ ）。 .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`CanvasTextureChannel` **CANVAS_TEXTURE_CHANNEL_NORMAL** = ``1`` 法线贴图画布纹理（\ :ref:`CanvasTexture.normal_texture`\ ）。 .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR: .. rst-class:: classref-enumeration-constant :ref:`CanvasTextureChannel` **CANVAS_TEXTURE_CHANNEL_SPECULAR** = ``2`` 高光贴图画布纹理（\ :ref:`CanvasTexture.specular_texture`\ ）。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_NinePatchAxisMode: .. rst-class:: classref-enumeration enum **NinePatchAxisMode**: :ref:`🔗` .. _class_RenderingServer_constant_NINE_PATCH_STRETCH: .. rst-class:: classref-enumeration-constant :ref:`NinePatchAxisMode` **NINE_PATCH_STRETCH** = ``0`` 九宫格在需要的地方被拉伸。 .. _class_RenderingServer_constant_NINE_PATCH_TILE: .. rst-class:: classref-enumeration-constant :ref:`NinePatchAxisMode` **NINE_PATCH_TILE** = ``1`` 九宫格在需要的地方填充图块。 .. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT: .. rst-class:: classref-enumeration-constant :ref:`NinePatchAxisMode` **NINE_PATCH_TILE_FIT** = ``2`` 九宫格在需要的地方填充图块，并在需要时将它们拉伸一点。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasItemTextureFilter: .. rst-class:: classref-enumeration enum **CanvasItemTextureFilter**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = ``0`` 为 :ref:`Viewport` 使用默认过滤模式。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``1`` 纹理过滤仅从最近的像素读取。这使得纹理从近距离看是像素化的，从远处看是颗粒状的（由于多级渐远纹理没有被采样）。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``2`` 纹理过滤在最近的 4 个像素之间进行混合。这使得纹理从近处看起来很平滑，从远处看起来却有颗粒感（由于多级渐远纹理没有被采样）。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3`` 纹理过滤从最近的像素读取并在最近的 2 个多级渐远纹理之间进行混合（或者如果 :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` 为 ``true``\ ，则使用最近的多级渐远纹理）。这使得纹理从近处看起来像素化，从远处看起来平滑。 将此用于可能以低缩放查看的非像素艺术纹理（例如，由于 :ref:`Camera2D` 缩放或精灵缩放），因为多级渐远纹理对于平滑小于屏幕像素的像素很重要。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4`` 纹理过滤在最近的 4 个像素和最近的 2 个多级渐远纹理之间进行混合（或者如果 :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` 为 ``true``\ ，则使用最近的多级渐远纹理）。这使得纹理从近处看起来平滑，从远处看起来也平滑。 将此用于可能以低缩放查看的非像素艺术纹理（例如，由于 :ref:`Camera2D` 缩放或精灵缩放），因为多级渐远纹理对于平滑小于屏幕像素的像素很重要。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5`` 纹理过滤从最近的像素读取并根据表面和相机视图之间的角度在 2 个多级渐远纹理之间进行混合（或者如果 :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` 为 ``true``\ ，则使用最近的多级渐远纹理）。这使得纹理从近处看起来像素化，从远处看起来平滑。各向异性过滤提高了几乎与相机位于一条线的表面上的纹理质量，但速度稍慢。各向异性过滤级别可以通过调整 :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level` 来改变。 \ **注意：**\ 该纹理过滤在 2D 项目中很少有用。\ :ref:`CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS` 在这种情况下通常更合适。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6`` 纹理过滤在最近的 4 个像素之间进行混合，并基于表面与相机视图之间的角度在 2 个多级渐远纹理之间进行混合（或者如果 :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter` 为 ``true``\ ，则使用最近的多级渐远纹理）。这使得纹理从近处看起来平滑，从远处看起来也平滑。各向异性过滤提高了几乎与相机位于一条线的表面上的纹理质量，但速度稍慢。各向异性过滤级别可以通过调整 :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level` 来改变。 \ **注意：**\ 该纹理过滤在 2D 项目中很少有用。\ :ref:`CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS` 在这种情况下通常更合适。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``7`` :ref:`CanvasItemTextureFilter` 枚举的最大值。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasItemTextureRepeat: .. rst-class:: classref-enumeration enum **CanvasItemTextureRepeat**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = ``0`` 为 :ref:`Viewport` 使用默认重复模式。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = ``1`` 禁用纹理重复。相反，当读取 0-1 范围之外的 UV 时，该值将被钳制在纹理的边缘，从而导致纹理的边界看起来被拉长。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = ``2`` 当 UV 坐标超出 0-1 范围时，使纹理能够重复。如果使用其中一种线性过滤模式，则当采样器过滤纹理边缘时，这可能会导致纹理边缘出现伪影。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``3`` 重复时翻转该纹理，使边缘对齐而不是突然改变。 .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``4`` :ref:`CanvasItemTextureRepeat` 枚举的最大值。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasGroupMode: .. rst-class:: classref-enumeration enum **CanvasGroupMode**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`CanvasGroupMode` **CANVAS_GROUP_MODE_DISABLED** = ``0`` 子级绘制在父级之上，不会被裁剪。 .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_ONLY: .. rst-class:: classref-enumeration-constant :ref:`CanvasGroupMode` **CANVAS_GROUP_MODE_CLIP_ONLY** = ``1`` 父级仅用于裁剪目的。子级被裁剪到父级的可见区域，不绘制父级。 .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_AND_DRAW: .. rst-class:: classref-enumeration-constant :ref:`CanvasGroupMode` **CANVAS_GROUP_MODE_CLIP_AND_DRAW** = ``2`` 父级用于裁剪子级，但在将子级剪裁到其可见区域之前，父级也像往常一样绘制在子级下方。 .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT: .. rst-class:: classref-enumeration-constant :ref:`CanvasGroupMode` **CANVAS_GROUP_MODE_TRANSPARENT** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasLightMode: .. rst-class:: classref-enumeration enum **CanvasLightMode**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightMode` **CANVAS_LIGHT_MODE_POINT** = ``0`` 2D 点光（见 :ref:`PointLight2D`\ ）。 .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightMode` **CANVAS_LIGHT_MODE_DIRECTIONAL** = ``1`` 2D 方向（日月）光（见 :ref:`DirectionalLight2D`\ ）。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasLightBlendMode: .. rst-class:: classref-enumeration enum **CanvasLightBlendMode**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightBlendMode` **CANVAS_LIGHT_BLEND_MODE_ADD** = ``0`` 向画布添加浅色。 .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightBlendMode` **CANVAS_LIGHT_BLEND_MODE_SUB** = ``1`` 从画布中减去浅色。 .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightBlendMode` **CANVAS_LIGHT_BLEND_MODE_MIX** = ``2`` 灯光根据透明度增加颜色。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasLightShadowFilter: .. rst-class:: classref-enumeration enum **CanvasLightShadowFilter**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightShadowFilter` **CANVAS_LIGHT_FILTER_NONE** = ``0`` 不要对画布上的光影应用滤镜。 .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightShadowFilter` **CANVAS_LIGHT_FILTER_PCF5** = ``1`` 使用 PCF5 过滤法来过滤画布的光影。 .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightShadowFilter` **CANVAS_LIGHT_FILTER_PCF13** = ``2`` 使用 PCF13 过滤法来过滤画布的光影。 .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightShadowFilter` **CANVAS_LIGHT_FILTER_MAX** = ``3`` :ref:`CanvasLightShadowFilter` 枚举的最大值。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasOccluderPolygonCullMode: .. rst-class:: classref-enumeration enum **CanvasOccluderPolygonCullMode**: :ref:`🔗` .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`CanvasOccluderPolygonCullMode` **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = ``0`` 禁用画布遮挡物的剔除。 .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE: .. rst-class:: classref-enumeration-constant :ref:`CanvasOccluderPolygonCullMode` **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = ``1`` 画布遮挡器的剔除是顺时针的。 .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE: .. rst-class:: classref-enumeration-constant :ref:`CanvasOccluderPolygonCullMode` **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = ``2`` 画布遮挡物的剔除是逆时针的。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_GlobalShaderParameterType: .. rst-class:: classref-enumeration enum **GlobalShaderParameterType**: :ref:`🔗` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_BOOL** = ``0`` 布尔型全局着色器参数（\ ``global uniform bool ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_BVEC2** = ``1`` 二维布尔向量全局着色器参数（\ ``global uniform bvec2 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_BVEC3** = ``2`` 三维布尔向量全局着色器参数（\ ``global uniform bvec3 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_BVEC4** = ``3`` 四维布尔向量全局着色器参数（\ ``global uniform bvec4 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_INT** = ``4`` 整数全局着色器参数（\ ``global uniform int ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_IVEC2** = ``5`` 二维整数向量全局着色器参数（\ ``global uniform ivec2 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_IVEC3** = ``6`` 三维整数向量全局着色器参数（\ ``global uniform ivec3 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_IVEC4** = ``7`` 四维整数向量全局着色器参数（\ ``global uniform ivec4 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_RECT2I** = ``8`` 二维整数矩形全局着色器参数（\ ``global uniform ivec4 ...``\ ）。等价于着色器代码中的 :ref:`GLOBAL_VAR_TYPE_IVEC4`\ ，但在编辑器 UI 中以 :ref:`Rect2i` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_UINT** = ``9`` 无符号整数全局着色器参数（\ ``global uniform uint ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_UVEC2** = ``10`` 二维无符号整数向量全局着色器参数（\ ``global uniform uvec2 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_UVEC3** = ``11`` 三维无符号整数向量全局着色器参数（\ ``global uniform uvec3 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_UVEC4** = ``12`` 四维无符号整数向量全局着色器参数（\ ``global uniform uvec4 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_FLOAT** = ``13`` 单精度浮点数全局着色器参数（\ ``global uniform float ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_VEC2** = ``14`` 二维单精度浮点数向量全局着色器参数（\ ``global uniform vec2 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_VEC3** = ``15`` 三维单精度浮点数向量全局着色器参数（\ ``global uniform vec3 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_VEC4** = ``16`` 四维单精度浮点数向量全局着色器参数（\ ``global uniform vec4 ...``\ ）。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_COLOR** = ``17`` 颜色全局着色器参数（\ ``global uniform vec4 ...``\ ）。等价于着色器代码中的 :ref:`GLOBAL_VAR_TYPE_VEC4`\ ，但在编辑器 UI 中以 :ref:`Color` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_RECT2** = ``18`` 二维浮点数矩形全局着色器参数（\ ``global uniform vec4 ...``\ ）。等价于着色器代码中的 :ref:`GLOBAL_VAR_TYPE_VEC4`\ ，但在编辑器 UI 中以 :ref:`Rect2` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_MAT2** = ``19`` 2×2 矩阵全局着色器参数（\ ``global uniform mat2 ...``\ ）。编辑器 UI 中以 :ref:`PackedInt32Array` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_MAT3** = ``20`` 3×3 矩阵全局着色器参数（\ ``global uniform mat3 ...``\ ）。编辑器 UI 中以 :ref:`Basis` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_MAT4** = ``21`` 4×4 矩阵全局着色器参数（\ ``global uniform mat4 ...``\ ）。编辑器 UI 中以 :ref:`Projection` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_TRANSFORM_2D** = ``22`` 二维变换全局着色器参数（\ ``global uniform mat2x3 ...``\ ）。编辑器 UI 中以 :ref:`Transform2D` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_TRANSFORM** = ``23`` 三维变换全局着色器参数（\ ``global uniform mat3x4 ...``\ ）。编辑器 UI 中以 :ref:`Transform3D` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLER2D** = ``24`` 2D 采样器全局着色器参数（\ ``global uniform sampler2D ...``\ ）。编辑器 UI 中以 :ref:`Texture2D` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = ``25`` 2D 采样器数组全局着色器参数（\ ``global uniform sampler2DArray ...``\ ）。编辑器 UI 中以 :ref:`Texture2DArray` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLER3D** = ``26`` 3D 采样器全局着色器参数（\ ``global uniform sampler3D ...``\ ）。编辑器 UI 中以 :ref:`Texture3D` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLERCUBE** = ``27`` 立方体贴图全局着色器参数（\ ``global uniform samplerCube ...``\ ）。编辑器 UI 中以 :ref:`Cubemap` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLEREXT: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLEREXT** = ``28`` 外部采样器全局着色器参数（\ ``global uniform samplerExternalOES ...``\ ）。编辑器 UI 中以 :ref:`ExternalTexture` 的形式暴露。 .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_MAX** = ``29`` 代表 :ref:`GlobalShaderParameterType` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_RenderingInfo: .. rst-class:: classref-enumeration enum **RenderingInfo**: :ref:`🔗` .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = ``0`` 在当前 3D 场景中渲染的对象数。会根据相机的位置和旋转的不同而不同。 .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = ``1`` 在当前 3D 场景中渲染的点、线、三角的数量。会根据相机的位置和旋转的不同而不同。 .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = ``2`` 在当前 3D 场景中渲染执行的绘制调用的数量。会根据相机的位置和旋转的不同而不同。 .. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_TEXTURE_MEM_USED** = ``3`` 纹理内存的使用量（单位为字节）。 .. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_BUFFER_MEM_USED** = ``4`` 缓冲内存的使用量（单位为字节）。包括顶点数据、uniform 缓冲以及内部使用的各种不同缓冲类型。 .. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_VIDEO_MEM_USED** = ``5`` 显存的使用量（单位为字节）。使用 Forward+ 或移动渲染器时，始终比 :ref:`RENDERING_INFO_TEXTURE_MEM_USED` 与 :ref:`RENDERING_INFO_BUFFER_MEM_USED` 的总和要大，因为这两项之外还有一些杂项数据。使用 Compatibility 渲染器时，等于 :ref:`RENDERING_INFO_TEXTURE_MEM_USED` 与 :ref:`RENDERING_INFO_BUFFER_MEM_USED` 之和。 .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS** = ``6`` 由 2D 画布渲染器触发的管线编译次数。 .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_MESH: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_MESH** = ``7`` 因加载网格而触发的管线编译次数。用户首次运行游戏且需要该管线时，这些编译会导致加载时间变长。 .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE** = ``8`` 因渲染场景前构建表面缓存而触发的管线编译次数。用户首次运行游戏且需要该管线时，这些编译会导致加载场景时的卡顿。 .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW** = ``9`` 因绘制场景而触发的管线编译次数。用户首次运行游戏且需要该管线时，这些编译会导致游戏过程中的卡顿。 .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION** = ``10`` 因优化当前场景而触发的管线编译次数。这些编译是在后台进行的，不会导致任何卡顿。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_PipelineSource: .. rst-class:: classref-enumeration enum **PipelineSource**: :ref:`🔗` .. _class_RenderingServer_constant_PIPELINE_SOURCE_CANVAS: .. rst-class:: classref-enumeration-constant :ref:`PipelineSource` **PIPELINE_SOURCE_CANVAS** = ``0`` 由 2D 画布渲染器触发的管线编译。 .. _class_RenderingServer_constant_PIPELINE_SOURCE_MESH: .. rst-class:: classref-enumeration-constant :ref:`PipelineSource` **PIPELINE_SOURCE_MESH** = ``1`` 因加载网格而触发的管线编译。 .. _class_RenderingServer_constant_PIPELINE_SOURCE_SURFACE: .. rst-class:: classref-enumeration-constant :ref:`PipelineSource` **PIPELINE_SOURCE_SURFACE** = ``2`` 因渲染场景前构建表面缓存而触发的管线编译。 .. _class_RenderingServer_constant_PIPELINE_SOURCE_DRAW: .. rst-class:: classref-enumeration-constant :ref:`PipelineSource` **PIPELINE_SOURCE_DRAW** = ``3`` 因绘制场景而触发的管线编译。 .. _class_RenderingServer_constant_PIPELINE_SOURCE_SPECIALIZATION: .. rst-class:: classref-enumeration-constant :ref:`PipelineSource` **PIPELINE_SOURCE_SPECIALIZATION** = ``4`` 因优化当前场景而触发的管线编译。 .. _class_RenderingServer_constant_PIPELINE_SOURCE_MAX: .. rst-class:: classref-enumeration-constant :ref:`PipelineSource` **PIPELINE_SOURCE_MAX** = ``5`` 代表 :ref:`PipelineSource` 枚举的大小。 .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_SplashStretchMode: .. rst-class:: classref-enumeration enum **SplashStretchMode**: :ref:`🔗` .. _class_RenderingServer_constant_SPLASH_STRETCH_MODE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`SplashStretchMode` **SPLASH_STRETCH_MODE_DISABLED** = ``0`` No stretching is applied. .. _class_RenderingServer_constant_SPLASH_STRETCH_MODE_KEEP: .. rst-class:: classref-enumeration-constant :ref:`SplashStretchMode` **SPLASH_STRETCH_MODE_KEEP** = ``1`` Stretches image to fullscreen while preserving aspect ratio. .. _class_RenderingServer_constant_SPLASH_STRETCH_MODE_KEEP_WIDTH: .. rst-class:: classref-enumeration-constant :ref:`SplashStretchMode` **SPLASH_STRETCH_MODE_KEEP_WIDTH** = ``2`` Stretches the height of the image based on the width of the screen. .. _class_RenderingServer_constant_SPLASH_STRETCH_MODE_KEEP_HEIGHT: .. rst-class:: classref-enumeration-constant :ref:`SplashStretchMode` **SPLASH_STRETCH_MODE_KEEP_HEIGHT** = ``3`` Stretches the width of the image based on the height of the screen. .. _class_RenderingServer_constant_SPLASH_STRETCH_MODE_COVER: .. rst-class:: classref-enumeration-constant :ref:`SplashStretchMode` **SPLASH_STRETCH_MODE_COVER** = ``4`` Stretches the image to cover the entire screen while preserving aspect ratio. .. _class_RenderingServer_constant_SPLASH_STRETCH_MODE_IGNORE: .. rst-class:: classref-enumeration-constant :ref:`SplashStretchMode` **SPLASH_STRETCH_MODE_IGNORE** = ``5`` Stretches the image to cover the entire screen but doesn't preserve aspect ratio. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_Features: .. rst-class:: classref-enumeration enum **Features**: :ref:`🔗` .. _class_RenderingServer_constant_FEATURE_SHADERS: .. rst-class:: classref-enumeration-constant :ref:`Features` **FEATURE_SHADERS** = ``0`` **已弃用：** This constant has not been used since Godot 3.0. .. _class_RenderingServer_constant_FEATURE_MULTITHREADED: .. rst-class:: classref-enumeration-constant :ref:`Features` **FEATURE_MULTITHREADED** = ``1`` **已弃用：** This constant has not been used since Godot 3.0. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group 常量 ---- .. _class_RenderingServer_constant_NO_INDEX_ARRAY: .. rst-class:: classref-constant **NO_INDEX_ARRAY** = ``-1`` :ref:`🔗` 标记一个错误，表明索引数组为空。 .. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE: .. rst-class:: classref-constant **ARRAY_WEIGHTS_SIZE** = ``4`` :ref:`🔗` 每个顶点的权重/骨骼数。 .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN: .. rst-class:: classref-constant **CANVAS_ITEM_Z_MIN** = ``-4096`` :ref:`🔗` 画布项目的最小 Z 层。 .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX: .. rst-class:: classref-constant **CANVAS_ITEM_Z_MAX** = ``4096`` :ref:`🔗` 画布项目的最大 Z 层。 .. _class_RenderingServer_constant_CANVAS_LAYER_MIN: .. rst-class:: classref-constant **CANVAS_LAYER_MIN** = ``-2147483648`` :ref:`🔗` 最小的画布层。 .. _class_RenderingServer_constant_CANVAS_LAYER_MAX: .. rst-class:: classref-constant **CANVAS_LAYER_MAX** = ``2147483647`` :ref:`🔗` 最大的画布层。 .. _class_RenderingServer_constant_MAX_GLOW_LEVELS: .. rst-class:: classref-constant **MAX_GLOW_LEVELS** = ``7`` :ref:`🔗` 辉光后期处理效果使用的最大辉光级别数。 .. _class_RenderingServer_constant_MAX_CURSORS: .. rst-class:: classref-constant **MAX_CURSORS** = ``8`` :ref:`🔗` **已弃用：** This constant is not used by the engine. .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS: .. rst-class:: classref-constant **MAX_2D_DIRECTIONAL_LIGHTS** = ``8`` :ref:`🔗` 2D 中同一时间能够渲染的最大方向光的数量。 .. _class_RenderingServer_constant_MAX_MESH_SURFACES: .. rst-class:: classref-constant **MAX_MESH_SURFACES** = ``256`` :ref:`🔗` 网格可拥有的最大表面数。 .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN: .. rst-class:: classref-constant **MATERIAL_RENDER_PRIORITY_MIN** = ``-128`` :ref:`🔗` 所有材质的最小渲染优先级。 .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX: .. rst-class:: classref-constant **MATERIAL_RENDER_PRIORITY_MAX** = ``127`` :ref:`🔗` 所有材质的最大渲染优先级。 .. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT: .. rst-class:: classref-constant **ARRAY_CUSTOM_COUNT** = ``4`` :ref:`🔗` 可用自定义数据数组的数量（\ :ref:`ARRAY_CUSTOM0`\ 、\ :ref:`ARRAY_CUSTOM1`\ 、\ :ref:`ARRAY_CUSTOM2`\ 、\ :ref:`ARRAY_CUSTOM3`\ ）。 .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_POSITION** = ``1`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = ``2`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_VELOCITY** = ``4`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_COLOR** = ``8`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by `contributing one `__! .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_CUSTOM** = ``16`` :ref:`🔗` .. container:: contribute There is currently no description for this constant. Please help us by `contributing one `__! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group 属性说明 -------- .. _class_RenderingServer_property_render_loop_enabled: .. rst-class:: classref-property :ref:`bool` **render_loop_enabled** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_render_loop_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_render_loop_enabled**\ (\ ) 如果为 ``false``\ ，则完全禁用渲染，但引擎逻辑仍在处理中。即使禁用渲染，你也可以调用 :ref:`force_draw()` 来绘制帧。 .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group 方法说明 -------- .. _class_RenderingServer_method_bake_render_uv2: .. rst-class:: classref-method :ref:`Array`\[:ref:`Image`\] **bake_render_uv2**\ (\ base\: :ref:`RID`, material_overrides\: :ref:`Array`\[:ref:`RID`\], image_size\: :ref:`Vector2i`\ ) :ref:`🔗` 使用可选的 ``material_overrides``\ ，将 ``base`` 参数中传递的 Mesh 的材质数据，烘焙为一组大小为 ``image_size`` 的 :ref:`Image`\ 。返回包含 :ref:`BakeChannels` 中指定的材质属性的 :ref:`Image` 数组。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_call_on_render_thread: .. rst-class:: classref-method |void| **call_on_render_thread**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` 由于 RenderingServer 实际逻辑可能在单独的线程上运行，因此从主（或任何其他）线程访问其内部将导致错误。为了更轻松地运行可以安全访问渲染内部的代码（例如 :ref:`RenderingDevice` 和类似的 RD 类），请通过该函数推送一个可调用对象，以便它将在渲染线程上执行。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_create: .. rst-class:: classref-method :ref:`RID` **camera_attributes_create**\ (\ ) :ref:`🔗` 创建相机属性对象并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``camera_attributes_`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价资源为 :ref:`CameraAttributes`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_auto_exposure: .. rst-class:: classref-method |void| **camera_attributes_set_auto_exposure**\ (\ camera_attributes\: :ref:`RID`, enable\: :ref:`bool`, min_sensitivity\: :ref:`float`, max_sensitivity\: :ref:`float`, speed\: :ref:`float`, scale\: :ref:`float`\ ) :ref:`🔗` 设置用于自动曝光效果的参数。这些参数与 :ref:`CameraAttributes` 和 :ref:`CameraAttributesPractical` 中的对应参数具有相同的含义。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur: .. rst-class:: classref-method |void| **camera_attributes_set_dof_blur**\ (\ camera_attributes\: :ref:`RID`, far_enable\: :ref:`bool`, far_distance\: :ref:`float`, far_transition\: :ref:`float`, near_enable\: :ref:`bool`, near_distance\: :ref:`float`, near_transition\: :ref:`float`, amount\: :ref:`float`\ ) :ref:`🔗` 设置用于 DOF 模糊效果的参数。这些参数与 :ref:`CameraAttributesPractical` 中的对应参数具有相同的含义。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape: .. rst-class:: classref-method |void| **camera_attributes_set_dof_blur_bokeh_shape**\ (\ shape\: :ref:`DOFBokehShape`\ ) :ref:`🔗` 设置 DOF 散景图案的形状。可以使用不同的形状来达到艺术效果，或达到性能目标。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality: .. rst-class:: classref-method |void| **camera_attributes_set_dof_blur_quality**\ (\ quality\: :ref:`DOFBlurQuality`, use_jitter\: :ref:`bool`\ ) :ref:`🔗` 将 DOF 模糊效果的质量级别设置为 ``quality``\ 。\ ``use_jitter`` 可用于抖动模糊过程中采集的样本，以隐藏伪影，代价是看起来更模糊。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_exposure: .. rst-class:: classref-method |void| **camera_attributes_set_exposure**\ (\ camera_attributes\: :ref:`RID`, multiplier\: :ref:`float`, normalization\: :ref:`float`\ ) :ref:`🔗` 设置渲染器所使用的曝光值。归一化量用于将给定的曝光值（Exposure Value，EV）烘焙进渲染计算，从而降低场景的动态范围。 可以用如下方法根据曝光值（EV100）来计算归一化系数： :: func get_exposure_normalization(ev100: float): return 1.0 / (pow(2.0, ev100) * 1.2) 可以使用如下方法根据光圈（单位为 F 值）、快门速度（单位为秒）、感光度（单位为 ISO）来计算曝光值： :: func get_exposure(aperture: float, shutter_speed: float, sensitivity: float): return log((aperture * aperture) / shutter_speed * (100.0 / sensitivity)) / log(2) .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_create: .. rst-class:: classref-method :ref:`RID` **camera_create**\ (\ ) :ref:`🔗` 创建 3D 相机并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``camera_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价节点为 :ref:`Camera3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_camera_attributes: .. rst-class:: classref-method |void| **camera_set_camera_attributes**\ (\ camera\: :ref:`RID`, effects\: :ref:`RID`\ ) :ref:`🔗` 将使用 :ref:`camera_attributes_create()` 创建的 camera_attributes 设置给给定的相机。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_compositor: .. rst-class:: classref-method |void| **camera_set_compositor**\ (\ camera\: :ref:`RID`, compositor\: :ref:`RID`\ ) :ref:`🔗` 设置该相机使用的合成器。相当于 :ref:`Camera3D.compositor`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_cull_mask: .. rst-class:: classref-method |void| **camera_set_cull_mask**\ (\ camera\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` 设置与该相机关联的剔除掩码。剔除掩码描述了该相机渲染了哪些 3D 图层。相当于 :ref:`Camera3D.cull_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_environment: .. rst-class:: classref-method |void| **camera_set_environment**\ (\ camera\: :ref:`RID`, env\: :ref:`RID`\ ) :ref:`🔗` 设置该相机使用的环境。相当于 :ref:`Camera3D.environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_frustum: .. rst-class:: classref-method |void| **camera_set_frustum**\ (\ camera\: :ref:`RID`, size\: :ref:`float`, offset\: :ref:`Vector2`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` 将相机设置为使用视锥投影。该模式允许调整 ``offset`` 参数以创建“倾斜视锥”效果。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_orthogonal: .. rst-class:: classref-method |void| **camera_set_orthogonal**\ (\ camera\: :ref:`RID`, size\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` 将相机设置为使用正交投影，也称为正射投影。物体在屏幕上保持相同的尺寸，无论它们有多远。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_perspective: .. rst-class:: classref-method |void| **camera_set_perspective**\ (\ camera\: :ref:`RID`, fovy_degrees\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) :ref:`🔗` 将相机设置为使用透视投影。屏幕上的物体在远处时变得更小。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_transform: .. rst-class:: classref-method |void| **camera_set_transform**\ (\ camera\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` 设置相机的 :ref:`Transform3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_use_vertical_aspect: .. rst-class:: classref-method |void| **camera_set_use_vertical_aspect**\ (\ camera\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则保留水平长宽比，相当于 :ref:`Camera3D.KEEP_WIDTH`\ 。如果为 ``false``\ ，则保留垂直长宽比，相当于 :ref:`Camera3D.KEEP_HEIGHT`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_create: .. rst-class:: classref-method :ref:`RID` **canvas_create**\ (\ ) :ref:`🔗` 创建画布并返回分配的 :ref:`RID`\ 。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``canvas_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 没有与画布等价的 :ref:`Resource` 或 :ref:`Node`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_animation_slice: .. rst-class:: classref-method |void| **canvas_item_add_animation_slice**\ (\ item\: :ref:`RID`, animation_length\: :ref:`float`, slice_begin\: :ref:`float`, slice_end\: :ref:`float`, offset\: :ref:`float` = 0.0\ ) :ref:`🔗` 后续的绘制命令将被忽略，除非它们位于指定的动画切片内。这是实现在背景上循环而不是不断重绘的动画的更快方法。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_circle: .. rst-class:: classref-method |void| **canvas_item_add_circle**\ (\ item\: :ref:`RID`, pos\: :ref:`Vector2`, radius\: :ref:`float`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上绘制一个圆圈。另见 :ref:`CanvasItem.draw_circle()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_clip_ignore: .. rst-class:: classref-method |void| **canvas_item_add_clip_ignore**\ (\ item\: :ref:`RID`, ignore\: :ref:`bool`\ ) :ref:`🔗` 如果 ``ignore`` 为 ``true``\ ，则使用该画布项绘制的项目会忽略裁剪，直到将 ``ignore`` 设置为 ``false`` 再次调用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_ellipse: .. rst-class:: classref-method |void| **canvas_item_add_ellipse**\ (\ item\: :ref:`RID`, pos\: :ref:`Vector2`, major\: :ref:`float`, minor\: :ref:`float`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` Draws an ellipse with semi-major axis ``major`` and semi-minor axis ``minor`` on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_ellipse()`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region: .. rst-class:: classref-method |void| **canvas_item_add_lcd_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color`\ ) :ref:`🔗` 另见 :ref:`CanvasItem.draw_lcd_texture_rect_region()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_line: .. rst-class:: classref-method |void| **canvas_item_add_line**\ (\ item\: :ref:`RID`, from\: :ref:`Vector2`, to\: :ref:`Vector2`, color\: :ref:`Color`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上画一条线。另见 :ref:`CanvasItem.draw_line()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_mesh: .. rst-class:: classref-method |void| **canvas_item_add_mesh**\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, transform\: :ref:`Transform2D` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color` = Color(1, 1, 1, 1), texture\: :ref:`RID` = RID()\ ) :ref:`🔗` 使用给定的 ``transform``\ 、\ ``modulate`` 颜色和 ``texture`` 绘制使用 :ref:`mesh_create()` 创建的网格。这由 :ref:`MeshInstance2D` 内部使用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region: .. rst-class:: classref-method |void| **canvas_item_add_msdf_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), outline_size\: :ref:`int` = 0, px_range\: :ref:`float` = 1.0, scale\: :ref:`float` = 1.0\ ) :ref:`🔗` 另见 :ref:`CanvasItem.draw_msdf_texture_rect_region()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_multiline: .. rst-class:: classref-method |void| **canvas_item_add_multiline**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上，绘制一个 2D 多线。另见 :ref:`CanvasItem.draw_multiline()` 和 :ref:`CanvasItem.draw_multiline_colors()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_multimesh: .. rst-class:: classref-method |void| **canvas_item_add_multimesh**\ (\ item\: :ref:`RID`, mesh\: :ref:`RID`, texture\: :ref:`RID` = RID()\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上，绘制一个 2D :ref:`MultiMesh`\ 。另见 :ref:`CanvasItem.draw_multimesh()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_nine_patch: .. rst-class:: classref-method |void| **canvas_item_add_nine_patch**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, source\: :ref:`Rect2`, texture\: :ref:`RID`, topleft\: :ref:`Vector2`, bottomright\: :ref:`Vector2`, x_axis_mode\: :ref:`NinePatchAxisMode` = 0, y_axis_mode\: :ref:`NinePatchAxisMode` = 0, draw_center\: :ref:`bool` = true, modulate\: :ref:`Color` = Color(1, 1, 1, 1)\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上，绘制一个九宫格矩形。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_particles: .. rst-class:: classref-method |void| **canvas_item_add_particles**\ (\ item\: :ref:`RID`, particles\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上绘制粒子。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_polygon: .. rst-class:: classref-method |void| **canvas_item_add_polygon**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), texture\: :ref:`RID` = RID()\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上绘制一个 2D 多边形。如果需要更高的灵活度（例如能够用到骨骼），请改用 :ref:`canvas_item_add_triangle_array()`\ 。另见 :ref:`CanvasItem.draw_polygon()`\ 。 \ **注意：**\ 如果你需要频繁重绘同样的多边形，包含大量顶点，请考虑预先使用 :ref:`Geometry2D.triangulate_polygon()` 进行三角剖分计算，并使用 :ref:`CanvasItem.draw_mesh()`\ 、\ :ref:`CanvasItem.draw_multimesh()` 或 :ref:`canvas_item_add_triangle_array()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_polyline: .. rst-class:: classref-method |void| **canvas_item_add_polyline**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, width\: :ref:`float` = -1.0, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上，绘制一个 2D 折线。另见 :ref:`CanvasItem.draw_polyline()` 和 :ref:`CanvasItem.draw_polyline_colors()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_primitive: .. rst-class:: classref-method |void| **canvas_item_add_primitive**\ (\ item\: :ref:`RID`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array`, texture\: :ref:`RID`\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上绘制一个 2D 图元。另见 :ref:`CanvasItem.draw_primitive()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_rect: .. rst-class:: classref-method |void| **canvas_item_add_rect**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, color\: :ref:`Color`, antialiased\: :ref:`bool` = false\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上绘制一个矩形。另见 :ref:`CanvasItem.draw_rect()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_set_transform: .. rst-class:: classref-method |void| **canvas_item_add_set_transform**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 设置将被用于变换后续画布项命令的 :ref:`Transform2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_texture_rect: .. rst-class:: classref-method |void| **canvas_item_add_texture_rect**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, tile\: :ref:`bool` = false, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上绘制一个有纹理的 2D 矩形。另见 :ref:`CanvasItem.draw_texture_rect()` 和 :ref:`Texture2D.draw_rect()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_texture_rect_region: .. rst-class:: classref-method |void| **canvas_item_add_texture_rect_region**\ (\ item\: :ref:`RID`, rect\: :ref:`Rect2`, texture\: :ref:`RID`, src_rect\: :ref:`Rect2`, modulate\: :ref:`Color` = Color(1, 1, 1, 1), transpose\: :ref:`bool` = false, clip_uv\: :ref:`bool` = true\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上绘制一个有纹理 2D 矩形的特定区域。另见 :ref:`CanvasItem.draw_texture_rect_region()` 和 :ref:`Texture2D.draw_rect_region()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_triangle_array: .. rst-class:: classref-method |void| **canvas_item_add_triangle_array**\ (\ item\: :ref:`RID`, indices\: :ref:`PackedInt32Array`, points\: :ref:`PackedVector2Array`, colors\: :ref:`PackedColorArray`, uvs\: :ref:`PackedVector2Array` = PackedVector2Array(), bones\: :ref:`PackedInt32Array` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array` = PackedFloat32Array(), texture\: :ref:`RID` = RID(), count\: :ref:`int` = -1\ ) :ref:`🔗` 在 ``item`` :ref:`RID` 指向的 :ref:`CanvasItem` 上绘制一个三角形数组。渲染 :ref:`Line2D` 和 :ref:`StyleBoxFlat` 时内部使用。\ :ref:`canvas_item_add_triangle_array()` 非常灵活，但用起来要比 :ref:`canvas_item_add_polygon()` 复杂。 \ **注意：**\ 如果 ``count`` 设置为非负值，则仅绘制前 ``count * 3`` 个索引（对应于 ``count`` 个三角形）。否则将绘制所有索引。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_attach_skeleton: .. rst-class:: classref-method |void| **canvas_item_attach_skeleton**\ (\ item\: :ref:`RID`, skeleton\: :ref:`RID`\ ) :ref:`🔗` 将骨架附加到 :ref:`CanvasItem` 上。会移除之前骨架。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_clear: .. rst-class:: classref-method |void| **canvas_item_clear**\ (\ item\: :ref:`RID`\ ) :ref:`🔗` 清空 :ref:`CanvasItem` 并删除其中的所有命令。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_create: .. rst-class:: classref-method :ref:`RID` **canvas_item_create**\ (\ ) :ref:`🔗` 新建 CanvasItem 实例并返回其 :ref:`RID`\ 。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``canvas_item_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价节点为 :ref:`CanvasItem`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter: .. rst-class:: classref-method :ref:`Variant` **canvas_item_get_instance_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| :ref:`🔗` 返回指定画布项实例的单实例着色器 uniform 取值。等价于 :ref:`CanvasItem.get_instance_shader_parameter()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter_default_value: .. rst-class:: classref-method :ref:`Variant` **canvas_item_get_instance_shader_parameter_default_value**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| :ref:`🔗` 返回指定画布项实例的单实例着色器 uniform 默认取值。等价于 :ref:`CanvasItem.get_instance_shader_parameter()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter_list: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **canvas_item_get_instance_shader_parameter_list**\ (\ instance\: :ref:`RID`\ ) |const| :ref:`🔗` 返回指定画布项实例的单实例着色器 uniform 名称的字典。 返回的字典使用 PropertyInfo 格式，包含 ``name``\ 、\ ``class_name``\ 、\ ``type``\ 、\ ``hint``\ 、\ ``hint_string`` 以及 ``usage`` 等字段。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_reset_physics_interpolation: .. rst-class:: classref-method |void| **canvas_item_reset_physics_interpolation**\ (\ item\: :ref:`RID`\ ) :ref:`🔗` 防止当前物理刻度的物理插值。 这在将画布项移动到新位置时很有用，可以产生瞬时变化，而不是从先前位置进行插值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode: .. rst-class:: classref-method |void| **canvas_item_set_canvas_group_mode**\ (\ item\: :ref:`RID`, mode\: :ref:`CanvasGroupMode`, clear_margin\: :ref:`float` = 5.0, fit_empty\: :ref:`bool` = false, fit_margin\: :ref:`float` = 0.0, blur_mipmaps\: :ref:`bool` = false\ ) :ref:`🔗` 设置对画布项进行 2D 渲染时使用的画布分组模式，画布项由 ``item`` RID 指定。要使用更快速但局限性更大的裁剪，请改用 :ref:`canvas_item_set_clip()`\ 。 \ **注意：**\ 等价的节点功能可以在 :ref:`CanvasGroup` 和 :ref:`CanvasItem.clip_children` 中找到。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_clip: .. rst-class:: classref-method |void| **canvas_item_set_clip**\ (\ item\: :ref:`RID`, clip\: :ref:`bool`\ ) :ref:`🔗` 如果 ``clip`` 为 ``true``\ ，则画布项不会在其矩形坐标之外绘制内容，画布项由 ``item`` RID 指定。这种裁剪很快，但只能用于轴对齐的矩形。也就是说裁剪矩形会忽略旋转。更高阶的裁剪形状请改用 :ref:`canvas_item_set_canvas_group_mode()`\ 。 \ **注意：**\ 等价的节点功能可以在 :ref:`Label.clip_text`\ 、\ :ref:`RichTextLabel`\ （始终启用）等处找到。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer: .. rst-class:: classref-method |void| **canvas_item_set_copy_to_backbuffer**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`, rect\: :ref:`Rect2`\ ) :ref:`🔗` 设置 :ref:`CanvasItem` 以将矩形复制到后台缓冲区。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_custom_rect: .. rst-class:: classref-method |void| **canvas_item_set_custom_rect**\ (\ item\: :ref:`RID`, use_custom_rect\: :ref:`bool`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0)\ ) :ref:`🔗` 如果 ``use_custom_rect`` 为 ``true``\ ，则将画布项 ``item`` 的自定义可见性框设置为 ``rect``\ （用于剔除）。设置自定义可见性框能够在绘制大量 2D 实例时降低 CPU 负载。如果 ``use_custom_rect`` 为 ``false``\ ，则会根据画布项的绘制命令自动计算可见性框。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_default_texture_filter: .. rst-class:: classref-method |void| **canvas_item_set_default_texture_filter**\ (\ item\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) :ref:`🔗` 设置 RID 为 ``item`` 的画布项的默认纹理过滤模式。等价于 :ref:`CanvasItem.texture_filter`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat: .. rst-class:: classref-method |void| **canvas_item_set_default_texture_repeat**\ (\ item\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) :ref:`🔗` 设置 RID 为 ``item`` 的画布项的默认纹理重复模式。等价于 :ref:`CanvasItem.texture_repeat`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_distance_field_mode: .. rst-class:: classref-method |void| **canvas_item_set_distance_field_mode**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果 ``enabled`` 为 ``true``\ ，则为 RID 为 ``item`` 的画布项启用多通道带符号距离场渲染模式。旨在用于字体渲染，或针对使用 `msdfgen `__ 生成的图像。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent: .. rst-class:: classref-method |void| **canvas_item_set_draw_behind_parent**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果 ``enabled`` 为 ``true``\ ，则为 RID 为 ``item`` 的画布项绘制在父级之后。等价于 :ref:`CanvasItem.show_behind_parent`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_draw_index: .. rst-class:: classref-method |void| **canvas_item_set_draw_index**\ (\ item\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` 设置 :ref:`CanvasItem` 的索引。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_instance_shader_parameter: .. rst-class:: classref-method |void| **canvas_item_set_instance_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` 设置指定画布项实例的单实例着色器 uniform。等价于 :ref:`CanvasItem.set_instance_shader_parameter()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_interpolated: .. rst-class:: classref-method |void| **canvas_item_set_interpolated**\ (\ item\: :ref:`RID`, interpolated\: :ref:`bool`\ ) :ref:`🔗` 如果 ``interpolated`` 为 ``true``\ ，则为该画布项打开物理插值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_light_mask: .. rst-class:: classref-method |void| **canvas_item_set_light_mask**\ (\ item\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 设置 RID 为 ``item`` 的画布项的灯光掩码 ``mask``\ 。等价于 :ref:`CanvasItem.light_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_material: .. rst-class:: classref-method |void| **canvas_item_set_material**\ (\ item\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` 设置 RID 为 ``item`` 的画布项的新材质 ``material``\ 。等价于 :ref:`CanvasItem.material`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_modulate: .. rst-class:: classref-method |void| **canvas_item_set_modulate**\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 将 RID 为 ``item`` 的画布项的颜色与其相乘，子项也受影响。另见 :ref:`canvas_item_set_self_modulate()`\ 。等价于 :ref:`CanvasItem.modulate`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_parent: .. rst-class:: classref-method |void| **canvas_item_set_parent**\ (\ item\: :ref:`RID`, parent\: :ref:`RID`\ ) :ref:`🔗` 为 :ref:`CanvasItem` 设置父级 :ref:`CanvasItem`\ 。该项目会从父级继承变换、调制、可见性，和场景树中的 :ref:`CanvasItem` 节点一样。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_self_modulate: .. rst-class:: classref-method |void| **canvas_item_set_self_modulate**\ (\ item\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 将 RID 为 ``item`` 的画布项的颜色与其相乘，子项不受影响。另见 :ref:`canvas_item_set_modulate()`\ 。等价于 :ref:`CanvasItem.self_modulate`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y: .. rst-class:: classref-method |void| **canvas_item_set_sort_children_by_y**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果 ``enabled`` 为 ``true``\ ，则会在绘制 Y 位置最低的子节点之后再绘制 Y 位置较高的子节点。Y 排序仅影响继承自该画布项的子级，不影响画布项自身，该画布项由 ``item`` RID 指定。等价于 :ref:`CanvasItem.y_sort_enabled`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_transform: .. rst-class:: classref-method |void| **canvas_item_set_transform**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 将 RID 为 ``item`` 的画布项的变换设置为 ``transform``\ 。会影响该画布项绘制的位置和方法。子级画布项的变换会与父级变换相乘。等价于 :ref:`Node2D.transform`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_use_parent_material: .. rst-class:: classref-method |void| **canvas_item_set_use_parent_material**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 设置 :ref:`CanvasItem` 是否使用其父级的材质。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_visibility_layer: .. rst-class:: classref-method |void| **canvas_item_set_visibility_layer**\ (\ item\: :ref:`RID`, visibility_layer\: :ref:`int`\ ) :ref:`🔗` 设置与这个 :ref:`CanvasItem` 关联的渲染可见性层。只有渲染掩码与此匹配的 :ref:`Viewport` 节点才会渲染这个 :ref:`CanvasItem`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_visibility_notifier: .. rst-class:: classref-method |void| **canvas_item_set_visibility_notifier**\ (\ item\: :ref:`RID`, enable\: :ref:`bool`, area\: :ref:`Rect2`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) :ref:`🔗` 将给定的 :ref:`CanvasItem` 设置为可见性通知器。\ ``area`` 定义可见性检查的区域。\ :ref:`CanvasItem` 进入屏幕时会调用 ``enter_callable``\ ，\ :ref:`CanvasItem` 退出屏幕时会调用 ``exit_callable``\ 。如果 ``enable`` 为 ``false``\ ，则该项目将不再作为通知器。 这个方法可用于手动模仿 :ref:`VisibleOnScreenNotifier2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_visible: .. rst-class:: classref-method |void| **canvas_item_set_visible**\ (\ item\: :ref:`RID`, visible\: :ref:`bool`\ ) :ref:`🔗` 设置 :ref:`CanvasItem` 的可见性。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent: .. rst-class:: classref-method |void| **canvas_item_set_z_as_relative_to_parent**\ (\ item\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果启用此选项，则父项的 Z 索引将添加到子项的 Z 索引中。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_z_index: .. rst-class:: classref-method |void| **canvas_item_set_z_index**\ (\ item\: :ref:`RID`, z_index\: :ref:`int`\ ) :ref:`🔗` 设置 :ref:`CanvasItem` 的 Z 索引，即它的绘制顺序（首先绘制数值较低的索引）。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_transform_physics_interpolation: .. rst-class:: classref-method |void| **canvas_item_transform_physics_interpolation**\ (\ item\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 同时变换画布项的当前变换和之前存储的变换。 这允许变换画布项而不会在插值中产生“卡顿”，这对于利用原点移位的大型世界特别有用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_attach_to_canvas: .. rst-class:: classref-method |void| **canvas_light_attach_to_canvas**\ (\ light\: :ref:`RID`, canvas\: :ref:`RID`\ ) :ref:`🔗` 将画布灯连接到画布上，并将其从以前的画布中取出。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_create: .. rst-class:: classref-method :ref:`RID` **canvas_light_create**\ (\ ) :ref:`🔗` 创建画布灯光并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``canvas_light_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价节点为 :ref:`Light2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas: .. rst-class:: classref-method |void| **canvas_light_occluder_attach_to_canvas**\ (\ occluder\: :ref:`RID`, canvas\: :ref:`RID`\ ) :ref:`🔗` 将光遮挡物添加到画布上,并将其从之前的画布中移除。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_create: .. rst-class:: classref-method :ref:`RID` **canvas_light_occluder_create**\ (\ ) :ref:`🔗` 创建光线遮挡器并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``canvas_light_occluder_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价节点为 :ref:`LightOccluder2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation: .. rst-class:: classref-method |void| **canvas_light_occluder_reset_physics_interpolation**\ (\ occluder\: :ref:`RID`\ ) :ref:`🔗` 阻止当前物理周期的物理插值。 适用于将遮挡器移动至新位置的情况，这样修改就是即时的，不会从原有位置进行插值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision: .. rst-class:: classref-method |void| **canvas_light_occluder_set_as_sdf_collision**\ (\ occluder\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_enabled: .. rst-class:: classref-method |void| **canvas_light_occluder_set_enabled**\ (\ occluder\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 启用或禁用遮光器。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_interpolated: .. rst-class:: classref-method |void| **canvas_light_occluder_set_interpolated**\ (\ occluder\: :ref:`RID`, interpolated\: :ref:`bool`\ ) :ref:`🔗` 如果 ``interpolated`` 为 ``true``\ ，则为该灯光遮挡器打开物理插值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_light_mask: .. rst-class:: classref-method |void| **canvas_light_occluder_set_light_mask**\ (\ occluder\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 光线遮罩。详见 :ref:`LightOccluder2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_polygon: .. rst-class:: classref-method |void| **canvas_light_occluder_set_polygon**\ (\ occluder\: :ref:`RID`, polygon\: :ref:`RID`\ ) :ref:`🔗` 设置光遮挡物的多边形。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_transform: .. rst-class:: classref-method |void| **canvas_light_occluder_set_transform**\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 设置光遮挡物的 :ref:`Transform2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation: .. rst-class:: classref-method |void| **canvas_light_occluder_transform_physics_interpolation**\ (\ occluder\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 同时变换光遮挡器的当前变换和之前存储的变换。 这允许变换遮挡器而不会在插值中产生“卡顿”，这对于利用原点移位的大型世界特别有用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_reset_physics_interpolation: .. rst-class:: classref-method |void| **canvas_light_reset_physics_interpolation**\ (\ light\: :ref:`RID`\ ) :ref:`🔗` 防止当前物理刻度的物理插值。 这在将画布项移动到新位置时很有用，可以产生瞬时变化，而不是从先前位置进行插值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_blend_mode: .. rst-class:: classref-method |void| **canvas_light_set_blend_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightBlendMode`\ ) :ref:`🔗` 将给定画布灯光的混合模式设置为 ``mode``\ 。等价于 :ref:`Light2D.blend_mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_color: .. rst-class:: classref-method |void| **canvas_light_set_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 设置灯光的颜色。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_enabled: .. rst-class:: classref-method |void| **canvas_light_set_enabled**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 启用或禁用画布灯。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_energy: .. rst-class:: classref-method |void| **canvas_light_set_energy**\ (\ light\: :ref:`RID`, energy\: :ref:`float`\ ) :ref:`🔗` 设置画布灯的能量。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_height: .. rst-class:: classref-method |void| **canvas_light_set_height**\ (\ light\: :ref:`RID`, height\: :ref:`float`\ ) :ref:`🔗` 设置画布灯的高度。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_interpolated: .. rst-class:: classref-method |void| **canvas_light_set_interpolated**\ (\ light\: :ref:`RID`, interpolated\: :ref:`bool`\ ) :ref:`🔗` 如果 ``interpolated`` 为 ``true``\ ，则为该画布灯光打开物理插值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_item_cull_mask: .. rst-class:: classref-method |void| **canvas_light_set_item_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 光线遮罩。详见 :ref:`LightOccluder2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask: .. rst-class:: classref-method |void| **canvas_light_set_item_shadow_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 用于确定此画布灯光阴影影响哪些图层的二进制蒙版。有关光遮罩的更多信息，请参阅 :ref:`LightOccluder2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_layer_range: .. rst-class:: classref-method |void| **canvas_light_set_layer_range**\ (\ light\: :ref:`RID`, min_layer\: :ref:`int`, max_layer\: :ref:`int`\ ) :ref:`🔗` 使用此灯光渲染的图层范围。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_mode: .. rst-class:: classref-method |void| **canvas_light_set_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`CanvasLightMode`\ ) :ref:`🔗` 设置画布灯的模式。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_shadow_color: .. rst-class:: classref-method |void| **canvas_light_set_shadow_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 设置画布灯的阴影颜色。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_shadow_enabled: .. rst-class:: classref-method |void| **canvas_light_set_shadow_enabled**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 启用或禁用画布灯的阴影。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_shadow_filter: .. rst-class:: classref-method |void| **canvas_light_set_shadow_filter**\ (\ light\: :ref:`RID`, filter\: :ref:`CanvasLightShadowFilter`\ ) :ref:`🔗` 设置画布灯的阴影过滤。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_shadow_smooth: .. rst-class:: classref-method |void| **canvas_light_set_shadow_smooth**\ (\ light\: :ref:`RID`, smooth\: :ref:`float`\ ) :ref:`🔗` 使阴影变得平滑。数值越低越光滑。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_texture: .. rst-class:: classref-method |void| **canvas_light_set_texture**\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` 设置 :ref:`PointLight2D` 所使用的纹理。相当于 :ref:`PointLight2D.texture`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_texture_offset: .. rst-class:: classref-method |void| **canvas_light_set_texture_offset**\ (\ light\: :ref:`RID`, offset\: :ref:`Vector2`\ ) :ref:`🔗` 设置 :ref:`PointLight2D` 纹理的偏移量。相当于 :ref:`PointLight2D.offset`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_texture_scale: .. rst-class:: classref-method |void| **canvas_light_set_texture_scale**\ (\ light\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` 设置 :ref:`PointLight2D` 纹理的缩放系数。相当于 :ref:`PointLight2D.texture_scale`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_transform: .. rst-class:: classref-method |void| **canvas_light_set_transform**\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 设置画布灯的 :ref:`Transform2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_z_range: .. rst-class:: classref-method |void| **canvas_light_set_z_range**\ (\ light\: :ref:`RID`, min_z\: :ref:`int`, max_z\: :ref:`int`\ ) :ref:`🔗` 设置将受此光影响的对象的 Z 范围。相当于 :ref:`Light2D.range_z_min` 和 :ref:`Light2D.range_z_max`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_transform_physics_interpolation: .. rst-class:: classref-method |void| **canvas_light_transform_physics_interpolation**\ (\ light\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 同时变换画布灯光的当前变换和之前存储的变换。 这样插值就可以在变换灯光的同时不产生“突变”，对于利用原点移位的大型世界特别有用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_occluder_polygon_create: .. rst-class:: classref-method :ref:`RID` **canvas_occluder_polygon_create**\ (\ ) :ref:`🔗` 新建光线遮挡多边形并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``canvas_occluder_polygon_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价节点为 :ref:`OccluderPolygon2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode: .. rst-class:: classref-method |void| **canvas_occluder_polygon_set_cull_mode**\ (\ occluder_polygon\: :ref:`RID`, mode\: :ref:`CanvasOccluderPolygonCullMode`\ ) :ref:`🔗` 设置遮光器多边形的剔除模式。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_occluder_polygon_set_shape: .. rst-class:: classref-method |void| **canvas_occluder_polygon_set_shape**\ (\ occluder_polygon\: :ref:`RID`, shape\: :ref:`PackedVector2Array`, closed\: :ref:`bool`\ ) :ref:`🔗` 设置遮挡多边形的形状。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_disable_scale: .. rst-class:: classref-method |void| **canvas_set_disable_scale**\ (\ disable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_item_mirroring: .. rst-class:: classref-method |void| **canvas_set_item_mirroring**\ (\ canvas\: :ref:`RID`, item\: :ref:`RID`, mirroring\: :ref:`Vector2`\ ) :ref:`🔗` 使用局部偏移量 ``mirroring`` 绘制画布项的副本。 \ **注意：**\ 等价于使用类似 ``canvas_set_item_repeat(item, mirroring, 1)`` 的代码调用 :ref:`canvas_set_item_repeat()`\ ，会进行额外的检查，确保 ``canvas`` 是 ``item`` 的父级。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_item_repeat: .. rst-class:: classref-method |void| **canvas_set_item_repeat**\ (\ item\: :ref:`RID`, repeat_size\: :ref:`Vector2`, repeat_times\: :ref:`int`\ ) :ref:`🔗` 将使用 ``repeat_size`` 的局部偏移量和 ``repeat_times`` 的次数来绘制画布项目的副本。随着 ``repeat_times`` 的增加，副本将从原始纹理蔓延开来。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_modulate: .. rst-class:: classref-method |void| **canvas_set_modulate**\ (\ canvas\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 调制给定画布中的所有颜色。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_shadow_texture_size: .. rst-class:: classref-method |void| **canvas_set_shadow_texture_size**\ (\ size\: :ref:`int`\ ) :ref:`🔗` 设置 :ref:`Light2D` 阴影渲染时使用的 :ref:`ProjectSettings.rendering/2d/shadow_atlas/size`\ （单位为像素）。该值会向上取整到最接近的 2 的幂。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_create: .. rst-class:: classref-method :ref:`RID` **canvas_texture_create**\ (\ ) :ref:`🔗` 创建画布纹理并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``canvas_texture_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。另见 :ref:`texture_2d_create()`\ 。 \ **注意：**\ 等价资源为 :ref:`CanvasTexture`\ ，应该仅用于 2D 渲染，不用于 3D。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_set_channel: .. rst-class:: classref-method |void| **canvas_texture_set_channel**\ (\ canvas_texture\: :ref:`RID`, channel\: :ref:`CanvasTextureChannel`, texture\: :ref:`RID`\ ) :ref:`🔗` 为画布纹理设置 ``channel`` 通道的纹理 ``texture``\ ，该画布纹理由 RID ``canvas_texture`` 指定。等价于 :ref:`CanvasTexture.diffuse_texture`\ 、\ :ref:`CanvasTexture.normal_texture` 和 :ref:`CanvasTexture.specular_texture`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_set_shading_parameters: .. rst-class:: classref-method |void| **canvas_texture_set_shading_parameters**\ (\ canvas_texture\: :ref:`RID`, base_color\: :ref:`Color`, shininess\: :ref:`float`\ ) :ref:`🔗` 为画布纹理设置 ``base_color`` 和 ``shininess``\ ，该画布纹理由 RID ``canvas_texture`` 指定。等价于 :ref:`CanvasTexture.specular_color` 和 :ref:`CanvasTexture.specular_shininess`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_set_texture_filter: .. rst-class:: classref-method |void| **canvas_texture_set_texture_filter**\ (\ canvas_texture\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) :ref:`🔗` 为画布纹理设置纹理过滤模式 ``filter``\ ，该画布纹理由 RID ``canvas_texture`` 指定。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_set_texture_repeat: .. rst-class:: classref-method |void| **canvas_texture_set_texture_repeat**\ (\ canvas_texture\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) :ref:`🔗` 为画布纹理设置纹理重复模式 ``repeat``\ ，该画布纹理由 RID ``canvas_texture`` 指定。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_compositor_create: .. rst-class:: classref-method :ref:`RID` **compositor_create**\ (\ ) :ref:`🔗` 创建一个新的合成器并将其添加到 RenderingServer。可以使用返回的 RID 来访问它。 RID 使用完后，你将需要使用 RenderingServer 的 :ref:`free_rid()` 方法释放该 RID。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_compositor_effect_create: .. rst-class:: classref-method :ref:`RID` **compositor_effect_create**\ (\ ) :ref:`🔗` 创建新的渲染效果并将其添加到 RenderingServer。可以使用返回的 RID 来访问它。 RID 使用完后，你将需要使用 RenderingServer 的 :ref:`free_rid()` 方法释放该 RID。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_compositor_effect_set_callback: .. rst-class:: classref-method |void| **compositor_effect_set_callback**\ (\ effect\: :ref:`RID`, callback_type\: :ref:`CompositorEffectCallbackType`, callback\: :ref:`Callable`\ ) :ref:`🔗` 设置该渲染效果的回调类型（\ ``callback_type``\ ）和回调方法（\ ``callback``\ ）。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_compositor_effect_set_enabled: .. rst-class:: classref-method |void| **compositor_effect_set_enabled**\ (\ effect\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 启用/禁用该渲染效果。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_compositor_effect_set_flag: .. rst-class:: classref-method |void| **compositor_effect_set_flag**\ (\ effect\: :ref:`RID`, flag\: :ref:`CompositorEffectFlags`, set\: :ref:`bool`\ ) :ref:`🔗` 将该渲染效果的标志（\ ``flag``\ ）设置为 ``true`` 或 ``false``\ （\ ``set``\ ）。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_compositor_set_compositor_effects: .. rst-class:: classref-method |void| **compositor_set_compositor_effects**\ (\ compositor\: :ref:`RID`, effects\: :ref:`Array`\[:ref:`RID`\]\ ) :ref:`🔗` 设置指定合成器 RID 的合成器效果。\ ``effects`` 应该是一个包含使用 :ref:`compositor_effect_create()` 创建的 RID 的数组。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_create_local_rendering_device: .. rst-class:: classref-method :ref:`RenderingDevice` **create_local_rendering_device**\ (\ ) |const| :ref:`🔗` 创建一个 RenderingDevice，可以用来在单独的线程上进行绘制和计算操作。不能绘制到屏幕上，也不能与全局的 RenderingDevice 共享数据。 \ **注意：**\ 使用 OpenGL 渲染驱动或在无头模式下运行时，这个函数始终返回 ``null`` 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_debug_canvas_item_get_rect: .. rst-class:: classref-method :ref:`Rect2` **debug_canvas_item_get_rect**\ (\ item\: :ref:`RID`\ ) :ref:`🔗` 返回渲染器计算出的局部空间中画布项的边界矩形。该边界在内部用于剔除。 \ **警告：**\ 该函数用于在编辑器中进行调试，并且将在导出的项目中跳过并返回零 :ref:`Rect2`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_create: .. rst-class:: classref-method :ref:`RID` **decal_create**\ (\ ) :ref:`🔗` 创建贴花并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``decal_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 如果要将这个贴花放置到场景中，请使用返回的 RID 调用 :ref:`instance_set_base()`\ ，将其附加至某个实例上。 \ **注意：**\ 等价节点为 :ref:`Decal`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_albedo_mix: .. rst-class:: classref-method |void| **decal_set_albedo_mix**\ (\ decal\: :ref:`RID`, albedo_mix\: :ref:`float`\ ) :ref:`🔗` 为贴花设置 ``albedo_mix``\ ，该贴花由 RID ``decal`` 指定。等价于 :ref:`Decal.albedo_mix`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_cull_mask: .. rst-class:: classref-method |void| **decal_set_cull_mask**\ (\ decal\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 为贴花设置剔除掩码 ``mask``\ ，该贴花由 RID ``decal`` 指定。等价于 :ref:`Decal.cull_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_distance_fade: .. rst-class:: classref-method |void| **decal_set_distance_fade**\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, length\: :ref:`float`\ ) :ref:`🔗` 为贴花设置距离淡出参数，该贴花由 RID ``decal`` 指定。等价于 :ref:`Decal.distance_fade_enabled`\ 、\ :ref:`Decal.distance_fade_begin` 和 :ref:`Decal.distance_fade_length`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_emission_energy: .. rst-class:: classref-method |void| **decal_set_emission_energy**\ (\ decal\: :ref:`RID`, energy\: :ref:`float`\ ) :ref:`🔗` 为贴花设置自发光能量 ``energy``\ ，该贴花由 RID ``decal`` 指定。等价于 :ref:`Decal.emission_energy`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_fade: .. rst-class:: classref-method |void| **decal_set_fade**\ (\ decal\: :ref:`RID`, above\: :ref:`float`, below\: :ref:`float`\ ) :ref:`🔗` 为贴花设置上侧淡出（\ ``above``\ ）和下侧淡出（\ ``below``\ ），该贴花由 RID ``decal`` 指定。等价于 :ref:`Decal.upper_fade` 和 :ref:`Decal.lower_fade`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_modulate: .. rst-class:: classref-method |void| **decal_set_modulate**\ (\ decal\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 将贴花的颜色乘数设置为 ``color``\ ，该贴花由 RID ``decal`` 指定。等价于 :ref:`Decal.modulate`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_normal_fade: .. rst-class:: classref-method |void| **decal_set_normal_fade**\ (\ decal\: :ref:`RID`, fade\: :ref:`float`\ ) :ref:`🔗` 设置 RID 为 ``decal`` 的贴花的法线淡出 ``fade``\ 。等价于 :ref:`Decal.normal_fade`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_size: .. rst-class:: classref-method |void| **decal_set_size**\ (\ decal\: :ref:`RID`, size\: :ref:`Vector3`\ ) :ref:`🔗` 设置 RID 为 ``decal`` 的贴花的大小 ``size``\ 。等价于 :ref:`Decal.size`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_texture: .. rst-class:: classref-method |void| **decal_set_texture**\ (\ decal\: :ref:`RID`, type\: :ref:`DecalTexture`, texture\: :ref:`RID`\ ) :ref:`🔗` 设置指定贴花中给定纹理类型插槽 ``type`` 的纹理 ``texture``\ 。等价于 :ref:`Decal.set_texture()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decals_set_filter: .. rst-class:: classref-method |void| **decals_set_filter**\ (\ filter\: :ref:`DecalFilter`\ ) :ref:`🔗` 设置渲染贴花时所使用的纹理过滤模式 ``filter``\ 。这个参数是全局的，无法针对某个贴花单独设置。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_directional_light_create: .. rst-class:: classref-method :ref:`RID` **directional_light_create**\ (\ ) :ref:`🔗` 创建平行光并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在大多数 ``light_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 如果要将这个平行光放置到场景中，请使用返回的 RID 调用 :ref:`instance_set_base()`\ ，将其附加至某个实例上。 \ **注意：**\ 等价节点为 :ref:`DirectionalLight3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_directional_shadow_atlas_set_size: .. rst-class:: classref-method |void| **directional_shadow_atlas_set_size**\ (\ size\: :ref:`int`, is_16bits\: :ref:`bool`\ ) :ref:`🔗` 设置 3D 方向灯光的阴影大小 ``size``\ 。另见 :ref:`ProjectSettings.rendering/lights_and_shadows/directional_shadow/size`\ 。这个参数是全局的，无法针对某个视口单独设置。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality: .. rst-class:: classref-method |void| **directional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality`\ ) :ref:`🔗` 设置 3D 方向灯光的阴影过滤质量 ``quality``\ 。另见 :ref:`ProjectSettings.rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality`\ 。这个参数是全局的，无法针对某个视口单独设置。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_bake_panorama: .. rst-class:: classref-method :ref:`Image` **environment_bake_panorama**\ (\ environment\: :ref:`RID`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Generates and returns an :ref:`Image` containing the radiance map for the specified ``environment`` RID's sky. This supports built-in sky material and custom sky shaders. If ``bake_irradiance`` is ``true``, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also :ref:`sky_bake_panorama()`. \ **Note:** The image is saved using linear encoding without any tonemapping performed, which means it will look too dark if viewed directly in an image editor. \ **Note:** ``size`` should be a 2:1 aspect ratio for the generated panorama to have square pixels. For radiance maps, there is no point in using a height greater than :ref:`Sky.radiance_size`, as it won't increase detail. Irradiance maps only contain low-frequency data, so there is usually no point in going past a size of 128×64 pixels when saving an irradiance map. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_create: .. rst-class:: classref-method :ref:`RID` **environment_create**\ (\ ) :ref:`🔗` 创建环境并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``environment_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价资源为 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale: .. rst-class:: classref-method |void| **environment_glow_set_use_bicubic_upscale**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` 如果 ``enable`` 为 ``true``\ ，则会为辉光启用双三次插值，能够牺牲性能、提升质量。等价于 :ref:`ProjectSettings.rendering/environment/glow/upscale_mode`\ 。 \ **注意：**\ 该设置仅在使用 Forward+ 或 Mobile 渲染方法时有效，因为 Compatibility 使用的辉光实现方法不同。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_adjustment: .. rst-class:: classref-method |void| **environment_set_adjustment**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, brightness\: :ref:`float`, contrast\: :ref:`float`, saturation\: :ref:`float`, use_1d_color_correction\: :ref:`bool`, color_correction\: :ref:`RID`\ ) :ref:`🔗` 设置用于“调整”后期处理效果的数值。详见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ambient_light: .. rst-class:: classref-method |void| **environment_set_ambient_light**\ (\ env\: :ref:`RID`, color\: :ref:`Color`, ambient\: :ref:`EnvironmentAmbientSource` = 0, energy\: :ref:`float` = 1.0, sky_contribution\: :ref:`float` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource` = 0\ ) :ref:`🔗` 设置用于环境光渲染的数值。详见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_background: .. rst-class:: classref-method |void| **environment_set_background**\ (\ env\: :ref:`RID`, bg\: :ref:`EnvironmentBG`\ ) :ref:`🔗` 设置环境的背景模式。等价于 :ref:`Environment.background_mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_bg_color: .. rst-class:: classref-method |void| **environment_set_bg_color**\ (\ env\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 场景中清屏区域的颜色。仅在使用 :ref:`ENV_BG_COLOR` 背景模式时有效。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_bg_energy: .. rst-class:: classref-method |void| **environment_set_bg_energy**\ (\ env\: :ref:`RID`, multiplier\: :ref:`float`, exposure_value\: :ref:`float`\ ) :ref:`🔗` 设置背景颜色的强度。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_camera_id: .. rst-class:: classref-method |void| **environment_set_camera_id**\ (\ env\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` 设置用作环境背景的相机 ID。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_canvas_max_layer: .. rst-class:: classref-method |void| **environment_set_canvas_max_layer**\ (\ env\: :ref:`RID`, max_layer\: :ref:`int`\ ) :ref:`🔗` 如果使用画布背景模式，设置要使用的最大层数。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_fog: .. rst-class:: classref-method |void| **environment_set_fog**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, light_color\: :ref:`Color`, light_energy\: :ref:`float`, sun_scatter\: :ref:`float`, density\: :ref:`float`, height\: :ref:`float`, height_density\: :ref:`float`, aerial_perspective\: :ref:`float`, sky_affect\: :ref:`float`, fog_mode\: :ref:`EnvironmentFogMode` = 0\ ) :ref:`🔗` 为指定的环境 RID 配置雾。详见 :ref:`Environment` 中的 ``fog_*`` 属性。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_fog_depth: .. rst-class:: classref-method |void| **environment_set_fog_depth**\ (\ env\: :ref:`RID`, curve\: :ref:`float`, begin\: :ref:`float`, end\: :ref:`float`\ ) :ref:`🔗` 为指定的环境 RID 配置雾深度。仅在环境中雾模式为 :ref:`ENV_FOG_MODE_DEPTH` 时有效。详见 :ref:`Environment` 中的 ``fog_depth_*`` 属性。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_glow: .. rst-class:: classref-method |void| **environment_set_glow**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, levels\: :ref:`PackedFloat32Array`, intensity\: :ref:`float`, strength\: :ref:`float`, mix\: :ref:`float`, bloom_threshold\: :ref:`float`, blend_mode\: :ref:`EnvironmentGlowBlendMode`, hdr_bleed_threshold\: :ref:`float`, hdr_bleed_scale\: :ref:`float`, hdr_luminance_cap\: :ref:`float`, glow_map_strength\: :ref:`float`, glow_map\: :ref:`RID`\ ) :ref:`🔗` 为指定的环境 RID 配置辉光。详见 :ref:`Environment` 中的 ``glow_*`` 属性。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sdfgi: .. rst-class:: classref-method |void| **environment_set_sdfgi**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, cascades\: :ref:`int`, min_cell_size\: :ref:`float`, y_scale\: :ref:`EnvironmentSDFGIYScale`, use_occlusion\: :ref:`bool`, bounce_feedback\: :ref:`float`, read_sky\: :ref:`bool`, energy\: :ref:`float`, normal_bias\: :ref:`float`, probe_bias\: :ref:`float`\ ) :ref:`🔗` 为指定的环境 RID 配置带符号距离场全局光照。详见 :ref:`Environment` 中的 ``sdfgi_*`` 属性。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge: .. rst-class:: classref-method |void| **environment_set_sdfgi_frames_to_converge**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge`\ ) :ref:`🔗` 设置用于聚合带符号距离场全局光照的帧数。等价于 :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_converge`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light: .. rst-class:: classref-method |void| **environment_set_sdfgi_frames_to_update_light**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight`\ ) :ref:`🔗` 设置计算带符号距离场全局光照时动态灯光间接光照的更新速度。等价于 :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sdfgi_ray_count: .. rst-class:: classref-method |void| **environment_set_sdfgi_ray_count**\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount`\ ) :ref:`🔗` 设置计算带符号距离场全局光照时每帧射出的光线数。等价于 :ref:`ProjectSettings.rendering/global_illumination/sdfgi/probe_ray_count`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sky: .. rst-class:: classref-method |void| **environment_set_sky**\ (\ env\: :ref:`RID`, sky\: :ref:`RID`\ ) :ref:`🔗` 设置当使用 *BGMode* 天空时被用作环境背景的 :ref:`Sky`\ 。相当于 :ref:`Environment.sky`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sky_custom_fov: .. rst-class:: classref-method |void| **environment_set_sky_custom_fov**\ (\ env\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` 为背景 :ref:`Sky` 设置自定义视野。相当于 :ref:`Environment.sky_custom_fov`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sky_orientation: .. rst-class:: classref-method |void| **environment_set_sky_orientation**\ (\ env\: :ref:`RID`, orientation\: :ref:`Basis`\ ) :ref:`🔗` 设置被表示为 :ref:`Basis` 的背景 :ref:`Sky` 的旋转。相当于 :ref:`Environment.sky_rotation`\ ，其中旋转向量用于构建该 :ref:`Basis`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssao: .. rst-class:: classref-method |void| **environment_set_ssao**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, radius\: :ref:`float`, intensity\: :ref:`float`, power\: :ref:`float`, detail\: :ref:`float`, horizon\: :ref:`float`, sharpness\: :ref:`float`, light_affect\: :ref:`float`, ao_channel_affect\: :ref:`float`\ ) :ref:`🔗` 设置屏幕空间环境光遮蔽（SSAO）后期处理效果所使用的变量。详见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssao_quality: .. rst-class:: classref-method |void| **environment_set_ssao_quality**\ (\ quality\: :ref:`EnvironmentSSAOQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) :ref:`🔗` 设置屏幕空间环境光遮蔽（SSAO）后期处理效果的质量级别。详见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssil_quality: .. rst-class:: classref-method |void| **environment_set_ssil_quality**\ (\ quality\: :ref:`EnvironmentSSILQuality`, half_size\: :ref:`bool`, adaptive_target\: :ref:`float`, blur_passes\: :ref:`int`, fadeout_from\: :ref:`float`, fadeout_to\: :ref:`float`\ ) :ref:`🔗` 设置屏幕空间间接照明（SSIL）后期处理效果的质量级别。详见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssr: .. rst-class:: classref-method |void| **environment_set_ssr**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, max_steps\: :ref:`int`, fade_in\: :ref:`float`, fade_out\: :ref:`float`, depth_tolerance\: :ref:`float`\ ) :ref:`🔗` 设置屏幕空间反射（SSR）后期处理效果所使用的变量。详见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssr_half_size: .. rst-class:: classref-method |void| **environment_set_ssr_half_size**\ (\ half_size\: :ref:`bool`\ ) :ref:`🔗` Sets whether screen-space reflections will be rendered at full or half size. Half size is faster, but may look pixelated or cause flickering. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssr_roughness_quality: .. rst-class:: classref-method |void| **environment_set_ssr_roughness_quality**\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality`\ ) :ref:`🔗` **已弃用：** This option no longer does anything. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_tonemap: .. rst-class:: classref-method |void| **environment_set_tonemap**\ (\ env\: :ref:`RID`, tone_mapper\: :ref:`EnvironmentToneMapper`, exposure\: :ref:`float`, white\: :ref:`float`\ ) :ref:`🔗` 设置“色调映射”后期处理效果所使用的变量。详见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_tonemap_agx_contrast: .. rst-class:: classref-method |void| **environment_set_tonemap_agx_contrast**\ (\ env\: :ref:`RID`, agx_contrast\: :ref:`float`\ ) :ref:`🔗` See :ref:`Environment.tonemap_agx_contrast` for more details. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_volumetric_fog: .. rst-class:: classref-method |void| **environment_set_volumetric_fog**\ (\ env\: :ref:`RID`, enable\: :ref:`bool`, density\: :ref:`float`, albedo\: :ref:`Color`, emission\: :ref:`Color`, emission_energy\: :ref:`float`, anisotropy\: :ref:`float`, length\: :ref:`float`, p_detail_spread\: :ref:`float`, gi_inject\: :ref:`float`, temporal_reprojection\: :ref:`bool`, temporal_reprojection_amount\: :ref:`float`, ambient_inject\: :ref:`float`, sky_affect\: :ref:`float`\ ) :ref:`🔗` 设置体积雾后期处理效果所使用的变量。详见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active: .. rst-class:: classref-method |void| **environment_set_volumetric_fog_filter_active**\ (\ active\: :ref:`bool`\ ) :ref:`🔗` 启用体积雾散射缓冲区的过滤。这会产生更平滑的体积，并且几乎没有欠采样伪影。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size: .. rst-class:: classref-method |void| **environment_set_volumetric_fog_volume_size**\ (\ size\: :ref:`int`, depth\: :ref:`int`\ ) :ref:`🔗` 设置体积雾的片段体素缓冲区分辨率。\ ``size`` 会被屏幕的纵横比修改，用于设置缓冲区的宽度和高度。\ ``depth`` 则用于设置缓冲区的深度。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_fog_volume_create: .. rst-class:: classref-method :ref:`RID` **fog_volume_create**\ (\ ) :ref:`🔗` 新建雾体积并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``fog_volume_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价节点为 :ref:`FogVolume`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_fog_volume_set_material: .. rst-class:: classref-method |void| **fog_volume_set_material**\ (\ fog_volume\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` 设置该雾体积的 :ref:`Material`\ 。可以是 :ref:`FogMaterial`\ ，也可以是自定义的 :ref:`ShaderMaterial`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_fog_volume_set_shape: .. rst-class:: classref-method |void| **fog_volume_set_shape**\ (\ fog_volume\: :ref:`RID`, shape\: :ref:`FogVolumeShape`\ ) :ref:`🔗` 将雾体积的形状设置为 :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`\ 、\ :ref:`FOG_VOLUME_SHAPE_CONE`\ 、\ :ref:`FOG_VOLUME_SHAPE_CYLINDER`\ 、\ :ref:`FOG_VOLUME_SHAPE_BOX` 或 :ref:`FOG_VOLUME_SHAPE_WORLD`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_fog_volume_set_size: .. rst-class:: classref-method |void| **fog_volume_set_size**\ (\ fog_volume\: :ref:`RID`, size\: :ref:`Vector3`\ ) :ref:`🔗` 设置形状为 :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`\ 、\ :ref:`FOG_VOLUME_SHAPE_CONE`\ 、\ :ref:`FOG_VOLUME_SHAPE_CYLINDER` 或 :ref:`FOG_VOLUME_SHAPE_BOX` 时，雾体积的大小。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_force_draw: .. rst-class:: classref-method |void| **force_draw**\ (\ swap_buffers\: :ref:`bool` = true, frame_step\: :ref:`float` = 0.0\ ) :ref:`🔗` 强制立即重绘所有视口。必须从主线程调用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_force_sync: .. rst-class:: classref-method |void| **force_sync**\ (\ ) :ref:`🔗` 强制在 CPU 和 GPU 之间进行同步，某些情况下是必须的。请只在需要时调用，因为 CPU-GPU 同步对性能有影响。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_free_rid: .. rst-class:: classref-method |void| **free_rid**\ (\ rid\: :ref:`RID`\ ) :ref:`🔗` 尝试释放 RenderingServer 中的某个对象。为了避免内存泄漏，应该在使用完对象后调用，因为直接使用 RenderingServer 时不会自动进行内存管理。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_current_rendering_driver_name: .. rst-class:: classref-method :ref:`String` **get_current_rendering_driver_name**\ (\ ) |const| :ref:`🔗` 返回当前渲染驱动的名称，可以是 ``vulkan``\ 、\ ``d3d12``\ 、\ ``metal``\ 、\ ``opengl3``\ 、\ ``opengl3_es`` 或 ``opengl3_angle``\ 。另见 :ref:`get_current_rendering_method()`. 当 :ref:`ProjectSettings.rendering/renderer/rendering_method` 为 ``forward_plus`` 或 ``mobile``\ 时，渲染驱动由 :ref:`ProjectSettings.rendering/rendering_device/driver` 决定。 当 :ref:`ProjectSettings.rendering/renderer/rendering_method` 为 ``gl_compatibility`` 时，渲染驱动由 :ref:`ProjectSettings.rendering/gl_compatibility/driver` 决定。 渲染驱动也由覆盖该项目设置的 ``--rendering-driver`` 命令行参数决定，或者由根据硬件而应用的自动回退决定。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_current_rendering_method: .. rst-class:: classref-method :ref:`String` **get_current_rendering_method**\ (\ ) |const| :ref:`🔗` 返回当前渲染方法的名称，可以是 ``forward_plus``\ 、\ ``mobile`` 或 ``gl_compatibility``\ 。另见 :ref:`get_current_rendering_driver_name()`. 渲染方法由 :ref:`ProjectSettings.rendering/renderer/rendering_method` 决定，\ ``--rendering-method`` 命令行参数会覆盖该项目设置，还会根据硬件应用自动回退。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_default_clear_color: .. rst-class:: classref-method :ref:`Color` **get_default_clear_color**\ (\ ) :ref:`🔗` 返回默认清屏颜色，会在没有选择特定的清屏颜色时使用。另见 :ref:`set_default_clear_color()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_frame_setup_time_cpu: .. rst-class:: classref-method :ref:`float` **get_frame_setup_time_cpu**\ (\ ) |const| :ref:`🔗` 返回在 CPU 上设置渲染所消耗的时间，单位为毫秒。这个值是所有视口共享的，\ *不需要*\ 在查询的视口上启用 :ref:`viewport_set_measure_render_time()`\ 。另见 :ref:`viewport_get_measured_render_time_cpu()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_rendering_device: .. rst-class:: classref-method :ref:`RenderingDevice` **get_rendering_device**\ (\ ) |const| :ref:`🔗` 返回全局的 RenderingDevice。 \ **注意：**\ 当使用 OpenGL 渲染驱动或在无头模式下运行时，这个函数始终返回 ``null``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_rendering_info: .. rst-class:: classref-method :ref:`int` **get_rendering_info**\ (\ info\: :ref:`RenderingInfo`\ ) :ref:`🔗` 返回关于渲染引擎的统计信息，能够用于性能分析。另见 :ref:`viewport_get_render_info()`\ ，返回的是某个视口的相关信息。 \ **注意：**\ 部分值目前仅考虑 3D 渲染，例如绘制调用的数量。 \ **注意：**\ 引擎渲染至少 2 帧后渲染信息才可用。渲染信息不可用时 :ref:`get_rendering_info()` 返回 ``0``\ 。要在 ``_ready()`` 中成功输出渲染信息，请使用如下代码： :: func _ready(): for _i in 2: await get_tree().process_frame print(RenderingServer.get_rendering_info(RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME)) .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_shader_parameter_list: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **get_shader_parameter_list**\ (\ shader\: :ref:`RID`\ ) |const| :ref:`🔗` 返回着色器的参数。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_test_cube: .. rst-class:: classref-method :ref:`RID` **get_test_cube**\ (\ ) :ref:`🔗` 返回测试立方体的 RID。首次调用 :ref:`get_test_cube()` 时会创建并返回该网格，然后为后续调用缓存。另见 :ref:`make_sphere_mesh()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_test_texture: .. rst-class:: classref-method :ref:`RID` **get_test_texture**\ (\ ) :ref:`🔗` 返回带有测试图案的 256×256 纹理（格式为 :ref:`Image.FORMAT_RGB8`\ ）。首次调用 :ref:`get_test_texture()` 时会创建并返回该纹理，然后为后续调用缓存。另见 :ref:`get_white_texture()`\ 。 \ **示例：**\ 获取测试纹理并将其应用至 :ref:`Sprite2D` 节点： :: var texture_rid = RenderingServer.get_test_texture() var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid)) $Sprite2D.texture = texture .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_video_adapter_api_version: .. rst-class:: classref-method :ref:`String` **get_video_adapter_api_version**\ (\ ) |const| :ref:`🔗` 返回\ *当前使用的*\ 图形视频适配器的版本（例如，Vulkan 为“1.2.189”，OpenGL 为“3.3.0 NVIDIA 510.60.02”）。该版本可能与硬件支持的实际最新版本不同，因为 Godot 可能并不总是要求最新版本。另见 :ref:`OS.get_video_adapter_driver_info()`\ 。 \ **注意：**\ 当运行无头或服务器可执行文件时，该函数返回一个空字符串。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_video_adapter_name: .. rst-class:: classref-method :ref:`String` **get_video_adapter_name**\ (\ ) |const| :ref:`🔗` 返回视频适配器的名称（例如“GeForce GTX 1080/PCIe/SSE2”）。 \ **注意：**\ 运行无头或服务器二进制文件时，该函数返回空字符串。 \ **注意：**\ 在 web 平台上，某些浏览器（例如 Firefox）可能会报告不同的固定 GPU 名称，例如“GeForce GTX 980”（无论用户的实际 GPU 型号如何）。这样做是为了使指纹识别更加困难。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_video_adapter_type: .. rst-class:: classref-method :ref:`DeviceType` **get_video_adapter_type**\ (\ ) |const| :ref:`🔗` 返回视频适配器的类型。由于给定代的专用显卡\ *通常*\ 明显快于同一代制造的集成显卡，因此设备类型可用作自动图形设置调整的基础。然而，这并不总是正确的，因此请确保为用户提供一种手动覆盖图形设置的方法。 \ **注意：**\ 当使用 OpenGL 渲染驱动或在无头模式下运行时，该函数始终返回 :ref:`RenderingDevice.DEVICE_TYPE_OTHER`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_video_adapter_vendor: .. rst-class:: classref-method :ref:`String` **get_video_adapter_vendor**\ (\ ) |const| :ref:`🔗` 返回视频适配器的供应商（例如 "NVIDIA Corporation"）。 \ **注意：**\ 当运行精简或服务器可执行文件时，该函数返回一个空字符串。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_white_texture: .. rst-class:: classref-method :ref:`RID` **get_white_texture**\ (\ ) :ref:`🔗` 返回 4×4 的白色纹理（格式为 :ref:`Image.FORMAT_RGB8`\ ）。首次调用 :ref:`get_white_texture()` 时会创建并返回该纹理，然后为后续调用缓存。另见 :ref:`get_test_texture()`\ 。 \ **示例：**\ 获取测试纹理并将其应用至 :ref:`Sprite2D` 节点： :: var texture_rid = RenderingServer.get_white_texture() var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid)) $Sprite2D.texture = texture .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_gi_set_use_half_resolution: .. rst-class:: classref-method |void| **gi_set_use_half_resolution**\ (\ half_resolution\: :ref:`bool`\ ) :ref:`🔗` 如果 ``half_resolution`` 为 ``true``\ ，则每个轴上都会使用一半的分辨率渲染 :ref:`VoxelGI` 和 SDFGI（\ :ref:`Environment.sdfgi_enabled`\ ）缓冲区（例如视口大小为 1920×1080 时使用 960×540）。启用 VoxelGI 或 SDFGI 时，这样做能够显著提升性能，但代价是多边形边缘可能产生显示问题。视口分辨率越高，越不容易注意到质量的损失。\ :ref:`LightmapGI` 的渲染不受这个设置的影响。等价于 :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_add: .. rst-class:: classref-method |void| **global_shader_parameter_add**\ (\ name\: :ref:`StringName`, type\: :ref:`GlobalShaderParameterType`, default_value\: :ref:`Variant`\ ) :ref:`🔗` 新建全局着色器 uniform。 \ **注意：**\ 全局着色器参数名称是大小写敏感的。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_get: .. rst-class:: classref-method :ref:`Variant` **global_shader_parameter_get**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` 返回名称为 ``name`` 的全局着色器 uniform 的值。 \ **注意：**\ :ref:`global_shader_parameter_get()` 存在较大的性能损耗，因为渲染线程需要与调用线程同步，这个过程比较慢。为了避免卡顿，请勿在游戏过程中使用这个方法。如果你需要在设置后在脚本中读取，请考虑创建一个自动加载，在设置全局参数的同时保存一份你需要查询的值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_get_list: .. rst-class:: classref-method :ref:`Array`\[:ref:`StringName`\] **global_shader_parameter_get_list**\ (\ ) |const| :ref:`🔗` 返回全局着色器 uniform 名称的列表。 \ **注意：**\ :ref:`global_shader_parameter_get()` 存在较大的性能损耗，因为渲染线程需要与调用线程同步，这个过程比较慢。为了避免卡顿，请勿在游戏过程中使用这个方法。如果你需要在设置后在脚本中读取，请考虑创建一个自动加载，在设置全局参数的同时保存一份你需要查询的值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_get_type: .. rst-class:: classref-method :ref:`GlobalShaderParameterType` **global_shader_parameter_get_type**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` 返回与名称为 ``name`` 的全局着色器 uniform 相关联的类型。 \ **注意：**\ :ref:`global_shader_parameter_get()` 存在较大的性能损耗，因为渲染线程需要与调用线程同步，这个过程比较慢。为了避免卡顿，请勿在游戏过程中使用这个方法。如果你需要在设置后在脚本中读取，请考虑创建一个自动加载，在设置全局参数的同时保存一份你需要查询的值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_remove: .. rst-class:: classref-method |void| **global_shader_parameter_remove**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` 移除名称为 ``name`` 的全局着色器 Uniform。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_set: .. rst-class:: classref-method |void| **global_shader_parameter_set**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` 将名称为 ``name`` 的全局着色器 Uniform 设置为 ``value``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_set_override: .. rst-class:: classref-method |void| **global_shader_parameter_set_override**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` 使用 ``value`` 覆盖名称为 ``name`` 的全局着色器 Uniform。等价于 :ref:`ShaderGlobalsOverride` 节点。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_has_changed: .. rst-class:: classref-method :ref:`bool` **has_changed**\ (\ ) |const| :ref:`🔗` 如果对 RenderingServer 的数据进行了更改，则返回 ``true``\ 。如果发生这种情况，通常会调用 :ref:`force_draw()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_has_feature: .. rst-class:: classref-method :ref:`bool` **has_feature**\ (\ feature\: :ref:`Features`\ ) |const| :ref:`🔗` **已弃用：** This method has not been used since Godot 3.0. 该方法不执行任何操作，并且始终返回 ``false``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_has_os_feature: .. rst-class:: classref-method :ref:`bool` **has_os_feature**\ (\ feature\: :ref:`String`\ ) |const| :ref:`🔗` 如果操作系统支持某个特性 ``feature``\ ，则返回 ``true``\ 。特性可以是 ``s3tc``\ 、\ ``etc``\ 、\ ``etc2``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_attach_object_instance_id: .. rst-class:: classref-method |void| **instance_attach_object_instance_id**\ (\ instance\: :ref:`RID`, id\: :ref:`int`\ ) :ref:`🔗` 将唯一的对象 ID 附加到实例上。必须将对象 ID 附加到实例上，以便通过 :ref:`instances_cull_aabb()`\ 、\ :ref:`instances_cull_convex()` 和 :ref:`instances_cull_ray()` 进行正确的筛除。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_attach_skeleton: .. rst-class:: classref-method |void| **instance_attach_skeleton**\ (\ instance\: :ref:`RID`, skeleton\: :ref:`RID`\ ) :ref:`🔗` 将骨架附加到实例。并从实例中移除之前骨架。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_create: .. rst-class:: classref-method :ref:`RID` **instance_create**\ (\ ) :ref:`🔗` 创建可视实例并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``instance_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 实例可以将 3D 对象放置到场景中。粒子、网格、反射探针、贴花等对象都需要使用 :ref:`instance_set_base()` 与实例关联，才能显示在场景中。 \ **注意：**\ 等价节点为 :ref:`VisualInstance3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_create2: .. rst-class:: classref-method :ref:`RID` **instance_create2**\ (\ base\: :ref:`RID`, scenario\: :ref:`RID`\ ) :ref:`🔗` 创建可视实例并将其添加到 RenderingServer、设置基础和场景。可以通过返回的 RID 进行访问。这个 RID 会在大多数 ``instance_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。这是使用 :ref:`instance_create()` 并手动设置基础和场景的快捷方式。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter: .. rst-class:: classref-method :ref:`Variant` **instance_geometry_get_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| :ref:`🔗` 返回指定 3D 几何体实例的单实例着色器 uniform 的值。等价于 :ref:`GeometryInstance3D.get_instance_shader_parameter()`\ 。 \ **注意：**\ 单实例着色器参数的名称是大小写敏感的。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value: .. rst-class:: classref-method :ref:`Variant` **instance_geometry_get_shader_parameter_default_value**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| :ref:`🔗` 返回指定 3D 几何体实例的单实例着色器 uniform 的默认值。等价于 :ref:`GeometryInstance3D.get_instance_shader_parameter()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **instance_geometry_get_shader_parameter_list**\ (\ instance\: :ref:`RID`\ ) |const| :ref:`🔗` 返回指定 3D 几何体实例的单实例着色器名称字典。返回的字典使用 PropertyInfo 格式，包含 ``name``\ 、\ ``class_name``\ 、\ ``type``\ 、\ ``hint``\ 、\ ``hint_string`` 以及 ``usage`` 等键。等价于 :ref:`GeometryInstance3D.get_instance_shader_parameter()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting: .. rst-class:: classref-method |void| **instance_geometry_set_cast_shadows_setting**\ (\ instance\: :ref:`RID`, shadow_casting_setting\: :ref:`ShadowCastingSetting`\ ) :ref:`🔗` 设置阴影的投射设置。等价于 :ref:`GeometryInstance3D.cast_shadow`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_flag: .. rst-class:: classref-method |void| **instance_geometry_set_flag**\ (\ instance\: :ref:`RID`, flag\: :ref:`InstanceFlags`, enabled\: :ref:`bool`\ ) :ref:`🔗` 将 ``instance`` 实例的 ``flag`` 标志的启用状态设置为 ``enabled``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_lightmap: .. rst-class:: classref-method |void| **instance_geometry_set_lightmap**\ (\ instance\: :ref:`RID`, lightmap\: :ref:`RID`, lightmap_uv_scale\: :ref:`Rect2`, lightmap_slice\: :ref:`int`\ ) :ref:`🔗` 为指定的 3D 几何体实例设置要使用的光照贴图 GI 实例。必须同时指定该实例的光照贴图 UV 缩放（等价于 :ref:`GeometryInstance3D.gi_lightmap_scale`\ ）和光照贴图图集切片。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_lod_bias: .. rst-class:: classref-method |void| **instance_geometry_set_lod_bias**\ (\ instance\: :ref:`RID`, lod_bias\: :ref:`float`\ ) :ref:`🔗` 为指定的 3D 几何体实例设置要使用的细节级别偏置。值越高，距离较远时的细节也会越高。等价于 :ref:`GeometryInstance3D.lod_bias`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_material_overlay: .. rst-class:: classref-method |void| **instance_geometry_set_material_overlay**\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` 设置一个材质，该材质将在与该实例关联的网格的活动材质之上，为所有表面渲染。相当于\ :ref:`GeometryInstance3D.material_overlay`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_material_override: .. rst-class:: classref-method |void| **instance_geometry_set_material_override**\ (\ instance\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` 设置一种材质，该材质将覆盖与此实例关联的网格上的所有表面的材质。相当于 :ref:`GeometryInstance3D.material_override`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_shader_parameter: .. rst-class:: classref-method |void| **instance_geometry_set_shader_parameter**\ (\ instance\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` 设置指定的 3D 几何体实例的单实例着色器 uniform。等价于 :ref:`GeometryInstance3D.set_instance_shader_parameter()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_transparency: .. rst-class:: classref-method |void| **instance_geometry_set_transparency**\ (\ instance\: :ref:`RID`, transparency\: :ref:`float`\ ) :ref:`🔗` 设置给定几何体实例的透明度。相当于 :ref:`GeometryInstance3D.transparency`\ 。 透明度为 ``0.0`` 时完全不透明，为 ``1.0`` 时则完全透明。如果值比 ``0.0`` 大，则会强制让几何体的材质经过透明管线，渲染起来相对较慢，可能由于错误的透明排序而产生渲染问题。不过，与使用透明材质不同，将 ``transparency`` 设置为比 ``0.0`` 大的值\ *不会*\ 禁用阴影的渲染。 在空间着色器中，内置 ``ALPHA`` 的默认值为 ``1.0 - transparency``\ 。 \ **注意：**\ ``transparency`` 会被钳制在 ``0.0`` 和 ``1.0`` 的范围内，所以这个属性无法让透明材质比原来更不透明。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_visibility_range: .. rst-class:: classref-method |void| **instance_geometry_set_visibility_range**\ (\ instance\: :ref:`RID`, min\: :ref:`float`, max\: :ref:`float`, min_margin\: :ref:`float`, max_margin\: :ref:`float`, fade_mode\: :ref:`VisibilityRangeFadeMode`\ ) :ref:`🔗` 设置给定几何实例的可见性范围值。相当于 :ref:`GeometryInstance3D.visibility_range_begin` 和相关属性。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_base: .. rst-class:: classref-method |void| **instance_set_base**\ (\ instance\: :ref:`RID`, base\: :ref:`RID`\ ) :ref:`🔗` 设置实例的基础。基础可以是在 RenderingServer 中创建的任何可以显示的 3D 对象。例如，任何光源类型、网格、多重网格、粒子系统、反射探针、贴花、光照贴图、体素 GI 和可见性通知器都可以设置为实例的基础，以便在场景中显示。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_blend_shape_weight: .. rst-class:: classref-method |void| **instance_set_blend_shape_weight**\ (\ instance\: :ref:`RID`, shape\: :ref:`int`, weight\: :ref:`float`\ ) :ref:`🔗` 设置与该实例相关的特定混合形状的权重。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_custom_aabb: .. rst-class:: classref-method |void| **instance_set_custom_aabb**\ (\ instance\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` 设置将对象从视锥中剔除时使用的自定义 AABB。相当于设置 :ref:`GeometryInstance3D.custom_aabb`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_extra_visibility_margin: .. rst-class:: classref-method |void| **instance_set_extra_visibility_margin**\ (\ instance\: :ref:`RID`, margin\: :ref:`float`\ ) :ref:`🔗` 设置将对象从视锥中剔除时为 AABB 增加的边距大小。这样就可以避免剔除落在视锥外的对象。相当于 :ref:`GeometryInstance3D.extra_cull_margin`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_ignore_culling: .. rst-class:: classref-method |void| **instance_set_ignore_culling**\ (\ instance\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则会忽略指定 3D 几何体实例的视锥剔除和遮挡剔除。和 :ref:`GeometryInstance3D.ignore_occlusion_culling` 不同，后者只会忽略遮挡剔除，仍会保留视锥剔除。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_layer_mask: .. rst-class:: classref-method |void| **instance_set_layer_mask**\ (\ instance\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 设置这个实例要绘制到的渲染层。相当于 :ref:`VisualInstance3D.layers`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_pivot_data: .. rst-class:: classref-method |void| **instance_set_pivot_data**\ (\ instance\: :ref:`RID`, sorting_offset\: :ref:`float`, use_aabb_center\: :ref:`bool`\ ) :ref:`🔗` 设置排序偏移量，并在使用包围框还是实例原点进行深度排序之间进行切换。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_scenario: .. rst-class:: classref-method |void| **instance_set_scenario**\ (\ instance\: :ref:`RID`, scenario\: :ref:`RID`\ ) :ref:`🔗` 设置实例所在的场景。场景是对象将在其中显示的 3D 世界。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_surface_override_material: .. rst-class:: classref-method |void| **instance_set_surface_override_material**\ (\ instance\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) :ref:`🔗` 设置指定表面的覆盖材质。相当于 :ref:`MeshInstance3D.set_surface_override_material()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_transform: .. rst-class:: classref-method |void| **instance_set_transform**\ (\ instance\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` 设置该实例的世界空间变换。相当于 :ref:`Node3D.global_transform`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_visibility_parent: .. rst-class:: classref-method |void| **instance_set_visibility_parent**\ (\ instance\: :ref:`RID`, parent\: :ref:`RID`\ ) :ref:`🔗` 设置给定实例的可见性父级。相当于 :ref:`Node3D.visibility_parent`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_visible: .. rst-class:: classref-method |void| **instance_set_visible**\ (\ instance\: :ref:`RID`, visible\: :ref:`bool`\ ) :ref:`🔗` 设置是否绘制实例。相当于 :ref:`Node3D.visible`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_teleport: .. rst-class:: classref-method |void| **instance_teleport**\ (\ instance\: :ref:`RID`\ ) :ref:`🔗` 重置运动向量及其他插值数据。将网格从一个位置传送至另一个位置\ *之后*\ ，请使用该函数来避免重影问题。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instances_cull_aabb: .. rst-class:: classref-method :ref:`PackedInt64Array` **instances_cull_aabb**\ (\ aabb\: :ref:`AABB`, scenario\: :ref:`RID` = RID()\ ) |const| :ref:`🔗` 返回与提供的 AABB 相交的对象 ID 的数组。仅考虑继承自 :ref:`VisualInstance3D` 的 3D 节点，例如 :ref:`MeshInstance3D` 或 :ref:`DirectionalLight3D`\ 。可使用 :ref:`@GlobalScope.instance_from_id()` 来获取实际节点。必须提供一个场景 RID，且它在要查询的 :ref:`World3D` 中可用。这会强制更新所有已被队列以等待更新的资源。 \ **警告：**\ 该函数主要供编辑器使用。对于游戏中的用例，最好是物理碰撞。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instances_cull_convex: .. rst-class:: classref-method :ref:`PackedInt64Array` **instances_cull_convex**\ (\ convex\: :ref:`Array`\[:ref:`Plane`\], scenario\: :ref:`RID` = RID()\ ) |const| :ref:`🔗` 返回与提供的凸形相交的对象 ID 的数组。仅考虑继承自 :ref:`VisualInstance3D` 的 3D 节点，例如 :ref:`MeshInstance3D` 或 :ref:`DirectionalLight3D`\ 。可使用 :ref:`@GlobalScope.instance_from_id()` 以获取实际节点。必须提供场景 RID，且它在要查询的 :ref:`World3D` 中可用。这会强制更新所有已被队列以等待更新的资源。 \ **警告：**\ 该函数主要供编辑器使用。对于游戏中的用例，最好是物理碰撞。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instances_cull_ray: .. rst-class:: classref-method :ref:`PackedInt64Array` **instances_cull_ray**\ (\ from\: :ref:`Vector3`, to\: :ref:`Vector3`, scenario\: :ref:`RID` = RID()\ ) |const| :ref:`🔗` 返回与提供的 3D 射线相交的对象 ID 的数组。仅考虑继承自 :ref:`VisualInstance3D` 的 3D 节点，例如 :ref:`MeshInstance3D` 或 :ref:`DirectionalLight3D`\ 。可使用 :ref:`@GlobalScope.instance_from_id()` 以获取实际节点。必须提供场景 RID，且它在你要查询的 :ref:`World3D` 中可用。这会强制更新所有已被队列以等待更新的资源。 \ **警告：**\ 该函数主要供编辑器使用。对于游戏中的用例，最好是物理碰撞。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_is_on_render_thread: .. rst-class:: classref-method :ref:`bool` **is_on_render_thread**\ (\ ) :ref:`🔗` 如果我们的代码当前正在渲染线程上执行，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_directional_set_blend_splits: .. rst-class:: classref-method |void| **light_directional_set_blend_splits**\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则该平行光将在阴影贴图分割之间混合，从而在它们之间产生更平滑的过渡。相当于 :ref:`DirectionalLight3D.directional_shadow_blend_splits`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_directional_set_shadow_mode: .. rst-class:: classref-method |void| **light_directional_set_shadow_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalShadowMode`\ ) :ref:`🔗` 设置平行光的阴影模式。相当于 :ref:`DirectionalLight3D.directional_shadow_mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_directional_set_sky_mode: .. rst-class:: classref-method |void| **light_directional_set_sky_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightDirectionalSkyMode`\ ) :ref:`🔗` 如果为 ``true``\ ，则该灯光将不会被用于除天空着色器之外的任何内容。将其用于影响天空着色器的灯光，可能希望隐藏这些灯光以免影响场景的其余部分。例如，当天空着色器中的太阳落在地平线以下时，可能希望启用该功能。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_omni_set_shadow_mode: .. rst-class:: classref-method |void| **light_omni_set_shadow_mode**\ (\ light\: :ref:`RID`, mode\: :ref:`LightOmniShadowMode`\ ) :ref:`🔗` 设置是使用双抛物面还是立方体贴图作为阴影贴图。双抛物面速度更快，但可能会出现伪影。相当于 :ref:`OmniLight3D.omni_shadow_mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_projectors_set_filter: .. rst-class:: classref-method |void| **light_projectors_set_filter**\ (\ filter\: :ref:`LightProjectorFilter`\ ) :ref:`🔗` 设置渲染光线投射器时使用的纹理过滤模式。这个参数是全局的，不能单独针对某个灯光进行设置。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_bake_mode: .. rst-class:: classref-method |void| **light_set_bake_mode**\ (\ light\: :ref:`RID`, bake_mode\: :ref:`LightBakeMode`\ ) :ref:`🔗` 设置指定 3D 灯光所使用的烘焙模式。相当于 :ref:`Light3D.light_bake_mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_color: .. rst-class:: classref-method |void| **light_set_color**\ (\ light\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 设置灯光的颜色。相当于 :ref:`Light3D.light_color`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_cull_mask: .. rst-class:: classref-method |void| **light_set_cull_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 设置该 3D 灯光的剔除掩码。灯光仅影响选定层中的对象。相当于 :ref:`Light3D.light_cull_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_distance_fade: .. rst-class:: classref-method |void| **light_set_distance_fade**\ (\ decal\: :ref:`RID`, enabled\: :ref:`bool`, begin\: :ref:`float`, shadow\: :ref:`float`, length\: :ref:`float`\ ) :ref:`🔗` 设置该 3D 灯光的淡入淡出距离。这充当了一种多细节层次（LOD）的形式，可用于提高性能。相当于 :ref:`Light3D.distance_fade_enabled`\ 、\ :ref:`Light3D.distance_fade_begin`\ 、\ :ref:`Light3D.distance_fade_shadow` 和 :ref:`Light3D.distance_fade_length`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_max_sdfgi_cascade: .. rst-class:: classref-method |void| **light_set_max_sdfgi_cascade**\ (\ light\: :ref:`RID`, cascade\: :ref:`int`\ ) :ref:`🔗` 设置渲染 3D 灯光间接光照时的 SDFGI 最大级联数。较高的值能够让远离相机的灯光在 SDFGI 中渲染。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_negative: .. rst-class:: classref-method |void| **light_set_negative**\ (\ light\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则该 3D 灯光会扣除光照而不是增加。等价于 :ref:`Light3D.light_negative`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_param: .. rst-class:: classref-method |void| **light_set_param**\ (\ light\: :ref:`RID`, param\: :ref:`LightParam`, value\: :ref:`float`\ ) :ref:`🔗` 设置指定的 3D 灯光参数。等价于 :ref:`Light3D.set_param()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_projector: .. rst-class:: classref-method |void| **light_set_projector**\ (\ light\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` 设置指定 3D 灯光使用的投射器纹理。等价于 :ref:`Light3D.light_projector`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_reverse_cull_face_mode: .. rst-class:: classref-method |void| **light_set_reverse_cull_face_mode**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则反转网格的背面剔除。当有一个背后有灯光的平面网格时，这会很有用。如果需要在网格的两侧投射阴影，请使用 :ref:`instance_geometry_set_cast_shadows_setting()`\ ，将网格设置为使用双面阴影。相当于 :ref:`Light3D.shadow_reverse_cull_face`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_shadow: .. rst-class:: classref-method |void| **light_set_shadow**\ (\ light\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则灯光会投射阴影。相当于 :ref:`Light3D.shadow_enabled`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_shadow_caster_mask: .. rst-class:: classref-method |void| **light_set_shadow_caster_mask**\ (\ light\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 设置该 3D 灯光的阴影投射器掩码。只会使用选定层中的对象投射阴影。等价于 :ref:`Light3D.shadow_caster_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_create: .. rst-class:: classref-method :ref:`RID` **lightmap_create**\ (\ ) :ref:`🔗` 新建全局光照的光照贴图并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``lightmap_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 与其等价的资源为 :ref:`LightmapGI`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree: .. rst-class:: classref-method :ref:`PackedInt32Array` **lightmap_get_probe_capture_bsp_tree**\ (\ lightmap\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_points: .. rst-class:: classref-method :ref:`PackedVector3Array` **lightmap_get_probe_capture_points**\ (\ lightmap\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_sh: .. rst-class:: classref-method :ref:`PackedColorArray` **lightmap_get_probe_capture_sh**\ (\ lightmap\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra: .. rst-class:: classref-method :ref:`PackedInt32Array` **lightmap_get_probe_capture_tetrahedra**\ (\ lightmap\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization: .. rst-class:: classref-method |void| **lightmap_set_baked_exposure_normalization**\ (\ lightmap\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) :ref:`🔗` 用于通知渲染器在烘焙光照贴图时使用的曝光归一化值。该值将在运行时被使用和被调制，以确保即使场景范围的曝光归一化值在运行时发生变化，光照贴图也能保持一致的曝光水平。有关详细信息，请参阅 :ref:`camera_attributes_set_exposure()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_probe_bounds: .. rst-class:: classref-method |void| **lightmap_set_probe_bounds**\ (\ lightmap\: :ref:`RID`, bounds\: :ref:`AABB`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_probe_capture_data: .. rst-class:: classref-method |void| **lightmap_set_probe_capture_data**\ (\ lightmap\: :ref:`RID`, points\: :ref:`PackedVector3Array`, point_sh\: :ref:`PackedColorArray`, tetrahedra\: :ref:`PackedInt32Array`, bsp_tree\: :ref:`PackedInt32Array`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed: .. rst-class:: classref-method |void| **lightmap_set_probe_capture_update_speed**\ (\ speed\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_probe_interior: .. rst-class:: classref-method |void| **lightmap_set_probe_interior**\ (\ lightmap\: :ref:`RID`, interior\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_textures: .. rst-class:: classref-method |void| **lightmap_set_textures**\ (\ lightmap\: :ref:`RID`, light\: :ref:`RID`, uses_sh\: :ref:`bool`\ ) :ref:`🔗` 将给定光照贴图 ``lightmap`` GI 实例的纹理设置为 ``light`` RID 所指向的纹理数组。如果烘焙光照贴图纹理时的 :ref:`LightmapGI.directional` 为 ``true``\ ，则 ``uses_sh`` 也必须为 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmaps_set_bicubic_filter: .. rst-class:: classref-method |void| **lightmaps_set_bicubic_filter**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` 切换在对光照贴图采样时是否使用双三次插值过滤。开启后能够让外观平滑，但会带来性能开销。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_make_sphere_mesh: .. rst-class:: classref-method :ref:`RID` **make_sphere_mesh**\ (\ latitudes\: :ref:`int`, longitudes\: :ref:`int`, radius\: :ref:`float`\ ) :ref:`🔗` 返回球体网格，具有给定数量的水平细分、垂直细分、半径。另见 :ref:`get_test_cube()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_create: .. rst-class:: classref-method :ref:`RID` **material_create**\ (\ ) :ref:`🔗` 创建空材质并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``material_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 与其等价的资源为 :ref:`Material`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_get_param: .. rst-class:: classref-method :ref:`Variant` **material_get_param**\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`\ ) |const| :ref:`🔗` 返回特定材质的参数值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_next_pass: .. rst-class:: classref-method |void| **material_set_next_pass**\ (\ material\: :ref:`RID`, next_material\: :ref:`RID`\ ) :ref:`🔗` 设置对象的下一个材质。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_param: .. rst-class:: classref-method |void| **material_set_param**\ (\ material\: :ref:`RID`, parameter\: :ref:`StringName`, value\: :ref:`Variant`\ ) :ref:`🔗` 设置材质的参数。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_render_priority: .. rst-class:: classref-method |void| **material_set_render_priority**\ (\ material\: :ref:`RID`, priority\: :ref:`int`\ ) :ref:`🔗` 设置材质的渲染优先级。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_shader: .. rst-class:: classref-method |void| **material_set_shader**\ (\ shader_material\: :ref:`RID`, shader\: :ref:`RID`\ ) :ref:`🔗` 设置着色器材质的着色器。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_use_debanding: .. rst-class:: classref-method |void| **material_set_use_debanding**\ (\ enable\: :ref:`bool`\ ) :ref:`🔗` When using the Mobile renderer, :ref:`material_set_use_debanding()` can be used to enable or disable the debanding feature of 3D materials (:ref:`BaseMaterial3D` and :ref:`ShaderMaterial`). \ :ref:`material_set_use_debanding()` has no effect when using the Compatibility or Forward+ renderer. In Forward+, :ref:`Viewport` debanding can be used instead. See also :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding` and :ref:`viewport_set_use_debanding()`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_add_surface: .. rst-class:: classref-method |void| **mesh_add_surface**\ (\ mesh\: :ref:`RID`, surface\: :ref:`Dictionary`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_add_surface_from_arrays: .. rst-class:: classref-method |void| **mesh_add_surface_from_arrays**\ (\ mesh\: :ref:`RID`, primitive\: :ref:`PrimitiveType`, arrays\: :ref:`Array`, blend_shapes\: :ref:`Array` = [], lods\: :ref:`Dictionary` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat`\] = 0\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_clear: .. rst-class:: classref-method |void| **mesh_clear**\ (\ mesh\: :ref:`RID`\ ) :ref:`🔗` 移除网格中的所有表面。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_create: .. rst-class:: classref-method :ref:`RID` **mesh_create**\ (\ ) :ref:`🔗` 新建网格并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``mesh_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 如果要将这个网格放置到场景中，请使用返回的 RID 调用 :ref:`instance_set_base()`\ ，将其附加至某个实例上。 \ **注意：**\ 与其等价的资源为 :ref:`Mesh`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_create_from_surfaces: .. rst-class:: classref-method :ref:`RID` **mesh_create_from_surfaces**\ (\ surfaces\: :ref:`Array`\[:ref:`Dictionary`\], blend_shape_count\: :ref:`int` = 0\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_blend_shape_count: .. rst-class:: classref-method :ref:`int` **mesh_get_blend_shape_count**\ (\ mesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回一个网格的混合形状数量。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_blend_shape_mode: .. rst-class:: classref-method :ref:`BlendShapeMode` **mesh_get_blend_shape_mode**\ (\ mesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回网格的混合形状模式。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_custom_aabb: .. rst-class:: classref-method :ref:`AABB` **mesh_get_custom_aabb**\ (\ mesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回网格的自定义 AABB。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_surface: .. rst-class:: classref-method :ref:`Dictionary` **mesh_get_surface**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_surface_count: .. rst-class:: classref-method :ref:`int` **mesh_get_surface_count**\ (\ mesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回网格的面数。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_set_blend_shape_mode: .. rst-class:: classref-method |void| **mesh_set_blend_shape_mode**\ (\ mesh\: :ref:`RID`, mode\: :ref:`BlendShapeMode`\ ) :ref:`🔗` 设置网格的混合形状模式。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_set_custom_aabb: .. rst-class:: classref-method |void| **mesh_set_custom_aabb**\ (\ mesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` 设置网格的自定义 AABB。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_set_shadow_mesh: .. rst-class:: classref-method |void| **mesh_set_shadow_mesh**\ (\ mesh\: :ref:`RID`, shadow_mesh\: :ref:`RID`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_arrays: .. rst-class:: classref-method :ref:`Array` **mesh_surface_get_arrays**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| :ref:`🔗` 返回网格表面的缓冲区数组。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays: .. rst-class:: classref-method :ref:`Array`\[:ref:`Array`\] **mesh_surface_get_blend_shape_arrays**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| :ref:`🔗` 返回网格表面的混合形状数组。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_attribute_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` 返回具有给定 ``format`` 的网格的属性缓冲区的步幅。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_index_stride: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_index_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` 返回具有给定 ``format`` 的网格的索引缓冲区的步幅。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_normal_tangent_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` 返回具有给定 ``format`` 的网格的组合法线和切线的步幅。重要的是请注意，虽然法线和切线位于带有顶点的顶点缓冲区中，但它们仅彼此交错，因此具有与顶点位置不同的步幅。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_offset: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_offset**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`, array_index\: :ref:`int`\ ) |const| :ref:`🔗` 返回由 ``array_index`` 给定属性在其各自缓冲区开头的偏移量。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_skin_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` 返回具有给定 ``format`` 的网格的皮肤缓冲区的步幅。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_vertex_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat`\], vertex_count\: :ref:`int`\ ) |const| :ref:`🔗` 返回具有给定 ``format`` 的网格的顶点位置的步幅。请注意，重要的是，顶点位置是连续存储的，并且不与顶点缓冲区中的其他属性（法线和切线）交错。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_material: .. rst-class:: classref-method :ref:`RID` **mesh_surface_get_material**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) |const| :ref:`🔗` 返回网格表面的材质。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_remove: .. rst-class:: classref-method |void| **mesh_surface_remove**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`\ ) :ref:`🔗` 移除 Mesh 中给定索引处的表面，将索引更大的表面向前移动一位。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_set_material: .. rst-class:: classref-method |void| **mesh_surface_set_material**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, material\: :ref:`RID`\ ) :ref:`🔗` 设置网格表面的材质。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_update_attribute_region: .. rst-class:: classref-method |void| **mesh_surface_update_attribute_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_update_index_region: .. rst-class:: classref-method |void| **mesh_surface_update_index_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` 使用 ``data`` 中给定的数据更新网格表面的索引缓冲。数据应为 16 位或 32 位无符号整数，可以通过 :ref:`mesh_surface_get_format_index_stride()` 确定。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_update_skin_region: .. rst-class:: classref-method |void| **mesh_surface_update_skin_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_update_vertex_region: .. rst-class:: classref-method |void| **mesh_surface_update_vertex_region**\ (\ mesh\: :ref:`RID`, surface\: :ref:`int`, offset\: :ref:`int`, data\: :ref:`PackedByteArray`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_allocate_data: .. rst-class:: classref-method |void| **multimesh_allocate_data**\ (\ multimesh\: :ref:`RID`, instances\: :ref:`int`, transform_format\: :ref:`MultimeshTransformFormat`, color_format\: :ref:`bool` = false, custom_data_format\: :ref:`bool` = false, use_indirect\: :ref:`bool` = false\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_create: .. rst-class:: classref-method :ref:`RID` **multimesh_create**\ (\ ) :ref:`🔗` 新建多网格并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``multimesh_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 如果要将这个多网格放置到场景中，请使用返回的 RID 调用 :ref:`instance_set_base()`\ ，将其附加至某个实例上。 \ **注意：**\ 与其等价的资源为 :ref:`MultiMesh`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_aabb: .. rst-class:: classref-method :ref:`AABB` **multimesh_get_aabb**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` 计算并返回轴对齐的边界框，该边界框将所有的实例都包含在 multimesh 中。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_buffer: .. rst-class:: classref-method :ref:`PackedFloat32Array` **multimesh_get_buffer**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回 MultiMesh 数据（例如实例的变换、颜色等）。有关返回数据的详细信息，请参阅 :ref:`multimesh_set_buffer()`\ 。 \ **注意：**\ 如果缓冲位于引擎的内部缓存中，则需要从 GPU 显存获取，并且有可能需要解压。也就是说 :ref:`multimesh_get_buffer()` 可能会比较慢，应该尽可能避免。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_buffer_rd_rid: .. rst-class:: classref-method :ref:`RID` **multimesh_get_buffer_rd_rid**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回 :ref:`MultiMesh` 在 :ref:`RenderingDevice` 中的 :ref:`RID` 句柄，可以在 RenderingDevice 上和其他缓冲一样使用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_command_buffer_rd_rid: .. rst-class:: classref-method :ref:`RID` **multimesh_get_command_buffer_rd_rid**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回 :ref:`MultiMesh` 命令缓冲在 :ref:`RenderingDevice` 中的 :ref:`RID` 句柄。通过 :ref:`multimesh_allocate_data()` 分配数据时，只有将 ``use_indirect`` 设为 ``true``\ ，这个 :ref:`RID` 才有效。可以用来通过缓冲直接修改实例的数量。 数据结构依赖于网格包含的表面数量以及是否使用索引，缓冲中有 5 个整数，不使用索引时不会使用最后一个整数。 缓冲中的值对应的选项如下： .. code:: text 使用索引： 0 - indexCount; 1 - instanceCount; 2 - firstIndex; 3 - vertexOffset; 4 - firstInstance; 不使用索引： 0 - vertexCount; 1 - instanceCount; 2 - firstVertex; 3 - firstInstance; 4 - unused; .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_custom_aabb: .. rst-class:: classref-method :ref:`AABB` **multimesh_get_custom_aabb**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回为该 MultiMesh 资源定义的自定义 AABB。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_instance_count: .. rst-class:: classref-method :ref:`int` **multimesh_get_instance_count**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回分配给这个 multimesh 的实例的数量。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_mesh: .. rst-class:: classref-method :ref:`RID` **multimesh_get_mesh**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回用于绘制此 multimesh 的 RID。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_visible_instances: .. rst-class:: classref-method :ref:`int` **multimesh_get_visible_instances**\ (\ multimesh\: :ref:`RID`\ ) |const| :ref:`🔗` 返回此 multimesh 的可见实例数。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_get_color: .. rst-class:: classref-method :ref:`Color` **multimesh_instance_get_color**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` 返回指定实例将被调制的颜色。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_get_custom_data: .. rst-class:: classref-method :ref:`Color` **multimesh_instance_get_custom_data**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` 返回与指定实例相关的自定义数据。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_get_transform: .. rst-class:: classref-method :ref:`Transform3D` **multimesh_instance_get_transform**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` 返回指定实例的 :ref:`Transform3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_get_transform_2d: .. rst-class:: classref-method :ref:`Transform2D` **multimesh_instance_get_transform_2d**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` 返回指定实例的 :ref:`Transform2D`\ 。只在 multimesh 设置为使用 2D 变换时使用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_reset_physics_interpolation: .. rst-class:: classref-method |void| **multimesh_instance_reset_physics_interpolation**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`\ ) :ref:`🔗` 在当前物理周期中阻止对指定实例进行物理插值。 适用于将实例移动到新位置的场合，可以产生瞬时变化，而不是从先前位置进行插值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_set_color: .. rst-class:: classref-method |void| **multimesh_instance_set_color**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, color\: :ref:`Color`\ ) :ref:`🔗` 设置这个实例的调制颜色。相当于 :ref:`MultiMesh.set_instance_color()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_set_custom_data: .. rst-class:: classref-method |void| **multimesh_instance_set_custom_data**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, custom_data\: :ref:`Color`\ ) :ref:`🔗` 为这个实例设置自定义数据。自定义数据以 :ref:`Color` 的形式传递，但在着色器中会被解释为 ``vec4``\ 。相当于 :ref:`MultiMesh.set_instance_custom_data()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_set_transform: .. rst-class:: classref-method |void| **multimesh_instance_set_transform**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` 为此实例设置 :ref:`Transform3D`\ 。相当于 :ref:`MultiMesh.set_instance_transform()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_set_transform_2d: .. rst-class:: classref-method |void| **multimesh_instance_set_transform_2d**\ (\ multimesh\: :ref:`RID`, index\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 为此实例设置 :ref:`Transform2D`\ 。用于在 2D 中使用 multimesh 时。相当于 :ref:`MultiMesh.set_instance_transform_2d()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instances_reset_physics_interpolation: .. rst-class:: classref-method |void| **multimesh_instances_reset_physics_interpolation**\ (\ multimesh\: :ref:`RID`\ ) :ref:`🔗` Prevents physics interpolation for all instances during the current physics tick. This is useful when moving all instances to new locations, to give instantaneous changes rather than interpolation from the previous locations. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_buffer: .. rst-class:: classref-method |void| **multimesh_set_buffer**\ (\ multimesh\: :ref:`RID`, buffer\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` 将用于绘制 ``multimesh`` 的全部数据立即写入 ``buffer``\ （例如实例的变换和颜色）。\ ``buffer`` 的大小必须与实例数和单实例数据大小的乘积匹配（后者取决于启用的 MultiMesh 字段）。否则，会输出错误信息，不渲染任何东西。另见 :ref:`multimesh_get_buffer()`\ 。 单实例数据大小与预期的数据顺序如下： .. code:: text 2D: - 位置：8 个 float（Transform2D 占 8 个 float） - 位置 + 顶点颜色：12 个 float（Transform2D 占 8 个 float、颜色占 4 个 float） - 位置 + 自定义数据：12 个 float（Transform2D 占 8 个 float、自定义数据占 4 个 float） - 位置 + 顶点颜色 + 自定义数据：16 个 float（Transform2D 占 8 个 float、颜色占 4 个 float、自定义数据占 4 个 float） 3D: - 位置：12 个 float（Transform3D 占 12 个 float） - 位置 + 顶点颜色：16 个 float（Transform3D 占 12 个 float、颜色占 4 个 float） - 位置 + 自定义数据：16 个 float（Transform3D 占 12 个 float、自定义数据占 4 个 float） - 位置 + 顶点颜色 + 自定义数据：20 个 float（Transform3D 占 12 个 float、颜色占 4 个 float、自定义数据占 4 个 float） 实例变换使用行主序，即： - :ref:`Transform2D` 的 float 顺序为：\ ``(x.x, y.x, padding_float, origin.x, x.y, y.y, padding_float, origin.y)``\ 。 - :ref:`Transform3D` 的 float 顺序为：\ ``(basis.x.x, basis.y.x, basis.z.x, origin.x, basis.x.y, basis.y.y, basis.z.y, origin.y, basis.x.z, basis.y.z, basis.z.z, origin.z)``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_buffer_interpolated: .. rst-class:: classref-method |void| **multimesh_set_buffer_interpolated**\ (\ multimesh\: :ref:`RID`, buffer\: :ref:`PackedFloat32Array`, buffer_previous\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` 适合物理插值的 :ref:`multimesh_set_buffer()` 版本。 接受当前数据数组以及上一物理周期的数据数组。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_custom_aabb: .. rst-class:: classref-method |void| **multimesh_set_custom_aabb**\ (\ multimesh\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` 为该 MultiMesh 资源设置自定义 AABB。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_mesh: .. rst-class:: classref-method |void| **multimesh_set_mesh**\ (\ multimesh\: :ref:`RID`, mesh\: :ref:`RID`\ ) :ref:`🔗` 设置 Multimesh 所要绘制的网格。相当于 :ref:`MultiMesh.mesh`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_physics_interpolated: .. rst-class:: classref-method |void| **multimesh_set_physics_interpolated**\ (\ multimesh\: :ref:`RID`, interpolated\: :ref:`bool`\ ) :ref:`🔗` 为该 MultiMesh 资源打开或关闭物理插值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_physics_interpolation_quality: .. rst-class:: classref-method |void| **multimesh_set_physics_interpolation_quality**\ (\ multimesh\: :ref:`RID`, quality\: :ref:`MultimeshPhysicsInterpolationQuality`\ ) :ref:`🔗` 设置 :ref:`MultiMesh` 物理插值的质量。 \ :ref:`MULTIMESH_INTERP_QUALITY_FAST` 较快但插值质量较低，\ :ref:`MULTIMESH_INTERP_QUALITY_HIGH` 较慢但插值质量较高。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_visible_instances: .. rst-class:: classref-method |void| **multimesh_set_visible_instances**\ (\ multimesh\: :ref:`RID`, visible\: :ref:`int`\ ) :ref:`🔗` 设置在给定时间内可见的实例的数量。如果是 -1，所有被分配的实例都会被画出来。相当于 :ref:`MultiMesh.visible_instance_count`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_occluder_create: .. rst-class:: classref-method :ref:`RID` **occluder_create**\ (\ ) :ref:`🔗` 创建遮挡器实例并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``occluder_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 与其等价的资源为 :ref:`Occluder3D`\ （请勿与 :ref:`OccluderInstance3D` 节点混淆）。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_occluder_set_mesh: .. rst-class:: classref-method |void| **occluder_set_mesh**\ (\ occluder\: :ref:`RID`, vertices\: :ref:`PackedVector3Array`, indices\: :ref:`PackedInt32Array`\ ) :ref:`🔗` 设置给定遮挡器 RID 的网格数据，控制执行遮挡剔除时的形状。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_omni_light_create: .. rst-class:: classref-method :ref:`RID` **omni_light_create**\ (\ ) :ref:`🔗` 创建一个新的全向灯并将其添加到 RenderingServer。可以使用返回的 RID 访问它。该 RID 可用于大多数 ``light_*`` RenderingServer 函数。 一旦使用 RID 完成操作后，需要使用 RenderingServer 的方法 :ref:`free_rid()` 来释放该 RID。 要放置在场景中，请使用 :ref:`instance_set_base()` 使用该返回的 RID 将该全向灯附加到一个实例。 \ **注意：**\ 等价节点为 :ref:`OmniLight3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_create: .. rst-class:: classref-method :ref:`RID` **particles_collision_create**\ (\ ) :ref:`🔗` 新建 3D GPU 粒子碰撞或吸引器并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``particles_collision_*`` RenderingServer 函数中使用。 \ **注意：**\ 等价节点为 :ref:`GPUParticlesCollision3D` 和 :ref:`GPUParticlesAttractor3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_height_field_update: .. rst-class:: classref-method |void| **particles_collision_height_field_update**\ (\ particles_collision\: :ref:`RID`\ ) :ref:`🔗` 请求对 3D GPU 粒子碰撞高度图进行更新。3D GPU 粒子碰撞高度图可能会自动调用这个函数，取决于 :ref:`GPUParticlesCollisionHeightField3D.update_mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation: .. rst-class:: classref-method |void| **particles_collision_set_attractor_attenuation**\ (\ particles_collision\: :ref:`RID`, curve\: :ref:`float`\ ) :ref:`🔗` 为 RID 为 ``particles_collision`` 的 3D GPU 粒子吸引器设置衰减曲线 ``curve``\ 。仅用于吸引器，对碰撞体不适用。等价于 :ref:`GPUParticlesAttractor3D.attenuation`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_attractor_directionality: .. rst-class:: classref-method |void| **particles_collision_set_attractor_directionality**\ (\ particles_collision\: :ref:`RID`, amount\: :ref:`float`\ ) :ref:`🔗` 设置 3D GPU 粒子吸引器的方向量 ``amount``\ ，吸引器由 RID ``particles_collision`` 指定。仅用于吸引器，不适用于碰撞体。等价于 :ref:`GPUParticlesAttractor3D.directionality`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_attractor_strength: .. rst-class:: classref-method |void| **particles_collision_set_attractor_strength**\ (\ particles_collision\: :ref:`RID`, strength\: :ref:`float`\ ) :ref:`🔗` 设置 3D GPU 粒子吸引器的强度 ``strength``\ ，吸引器由 RID ``particles_collision`` 指定。仅用于吸引器，不适用于碰撞体。等价于 :ref:`GPUParticlesAttractor3D.strength`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_box_extents: .. rst-class:: classref-method |void| **particles_collision_set_box_extents**\ (\ particles_collision\: :ref:`RID`, extents\: :ref:`Vector3`\ ) :ref:`🔗` 设置 3D GPU 粒子吸引器的范围 ``extents``\ ，吸引器由 RID ``particles_collision`` 指定。根据 ``particles_collision`` 类型的不同，等价于 :ref:`GPUParticlesCollisionBox3D.size`\ 、\ :ref:`GPUParticlesCollisionSDF3D.size`\ 、\ :ref:`GPUParticlesCollisionHeightField3D.size`\ 、\ :ref:`GPUParticlesAttractorBox3D.size`\ 、\ :ref:`GPUParticlesAttractorVectorField3D.size`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_collision_type: .. rst-class:: classref-method |void| **particles_collision_set_collision_type**\ (\ particles_collision\: :ref:`RID`, type\: :ref:`ParticlesCollisionType`\ ) :ref:`🔗` 设置 3D GPU 粒子碰撞或吸引器的形状类型 ``type``\ ，碰撞或吸引器由 RID ``particles_collision`` 指定。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_cull_mask: .. rst-class:: classref-method |void| **particles_collision_set_cull_mask**\ (\ particles_collision\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 设置 3D GPU 粒子碰撞或吸引器的剔除掩码 ``mask``\ ，碰撞或吸引器由 RID ``particles_collision`` 指定。根据 ``particles_collision`` 类型的不同，等价于 :ref:`GPUParticlesCollision3D.cull_mask` 或 :ref:`GPUParticlesAttractor3D.cull_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_field_texture: .. rst-class:: classref-method |void| **particles_collision_set_field_texture**\ (\ particles_collision\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` 设置 3D GPU 粒子碰撞的带符号距离场纹理 ``texture``\ ，碰撞由 RID ``particles_collision`` 指定。根据 ``particles_collision`` 类型的不同，等价于 :ref:`GPUParticlesCollisionSDF3D.texture` 或 :ref:`GPUParticlesAttractorVectorField3D.texture`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_height_field_mask: .. rst-class:: classref-method |void| **particles_collision_set_height_field_mask**\ (\ particles_collision\: :ref:`RID`, mask\: :ref:`int`\ ) :ref:`🔗` 设置 3D GPU 粒子高度图碰撞的高度图掩码 ``mask``\ ，碰撞由 RID ``particles_collision`` 指定。等价于 :ref:`GPUParticlesCollisionHeightField3D.heightfield_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_height_field_resolution: .. rst-class:: classref-method |void| **particles_collision_set_height_field_resolution**\ (\ particles_collision\: :ref:`RID`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution`\ ) :ref:`🔗` 设置 3D GPU 粒子高度图碰撞的高度图分辨率 ``resolution``\ ，碰撞由 RID ``particles_collision`` 指定。等价于 :ref:`GPUParticlesCollisionHeightField3D.resolution`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_sphere_radius: .. rst-class:: classref-method |void| **particles_collision_set_sphere_radius**\ (\ particles_collision\: :ref:`RID`, radius\: :ref:`float`\ ) :ref:`🔗` 设置 3D GPU 粒子球体碰撞或吸引器的半径 ``radius``\ ，碰撞或吸引器由 RID ``particles_collision`` 指定。根据 ``particles_collision`` 类型的不同，等价于 :ref:`GPUParticlesCollisionSphere3D.radius` 或 :ref:`GPUParticlesAttractorSphere3D.radius`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_create: .. rst-class:: classref-method :ref:`RID` **particles_create**\ (\ ) :ref:`🔗` 创建基于 GPU 的粒子系统并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``particles_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 如果要将这个粒子系统放置到场景中，请使用返回的 RID 调用 :ref:`instance_set_base()`\ ，将其附加至某个实例上。 \ **注意：**\ 等价节点为 :ref:`GPUParticles2D` 和 :ref:`GPUParticles3D`\ 。 \ **注意：**\ 所有 ``particles_*`` 方法都仅适用于基于 GPU 的粒子，不适用于基于 CPU 的粒子。RenderingServer 中没有 :ref:`CPUParticles2D` 和 :ref:`CPUParticles3D` 的等价函数，因为这两个节点底层使用的是 :ref:`MultiMeshInstance2D` 和 :ref:`MultiMeshInstance3D`\ （见 ``multimesh_*`` 方法）。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_emit: .. rst-class:: classref-method |void| **particles_emit**\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`, velocity\: :ref:`Vector3`, color\: :ref:`Color`, custom\: :ref:`Color`, emit_flags\: :ref:`int`\ ) :ref:`🔗` 从 ``particles`` 实例中手动发射粒子。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_get_current_aabb: .. rst-class:: classref-method :ref:`AABB` **particles_get_current_aabb**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` 计算并返回包含所有粒子的轴对齐边界框。相当于 :ref:`GPUParticles3D.capture_aabb()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_get_emitting: .. rst-class:: classref-method :ref:`bool` **particles_get_emitting**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` 如果当前粒子被设置发射，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_is_inactive: .. rst-class:: classref-method :ref:`bool` **particles_is_inactive**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` 如果粒子没有发射并且粒子设置为非活动状态，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_request_process: .. rst-class:: classref-method |void| **particles_request_process**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` 将粒子系统添加到需要更新的粒子系统列表中。更新将在下一帧或下一次调用 :ref:`instances_cull_aabb()`\ 、\ :ref:`instances_cull_convex()` 或 :ref:`instances_cull_ray()` 时进行。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_request_process_time: .. rst-class:: classref-method |void| **particles_request_process_time**\ (\ particles\: :ref:`RID`, time\: :ref:`float`\ ) :ref:`🔗` 请求粒子在单一帧中再处理指定的时间。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_restart: .. rst-class:: classref-method |void| **particles_restart**\ (\ particles\: :ref:`RID`\ ) :ref:`🔗` 下次更新时重置粒子。相当于 :ref:`GPUParticles3D.restart()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_amount: .. rst-class:: classref-method |void| **particles_set_amount**\ (\ particles\: :ref:`RID`, amount\: :ref:`int`\ ) :ref:`🔗` 设置要绘制的粒子的数量，并为其分配内存。相当于 :ref:`GPUParticles3D.amount`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_amount_ratio: .. rst-class:: classref-method |void| **particles_set_amount_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) :ref:`🔗` 设置要被发射的粒子的数量比率。相当于 :ref:`GPUParticles3D.amount_ratio`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_collision_base_size: .. rst-class:: classref-method |void| **particles_set_collision_base_size**\ (\ particles\: :ref:`RID`, size\: :ref:`float`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_custom_aabb: .. rst-class:: classref-method |void| **particles_set_custom_aabb**\ (\ particles\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` 设置粒子系统的自定义轴对齐边界框。相当于 :ref:`GPUParticles3D.visibility_aabb`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_draw_order: .. rst-class:: classref-method |void| **particles_set_draw_order**\ (\ particles\: :ref:`RID`, order\: :ref:`ParticlesDrawOrder`\ ) :ref:`🔗` 设置粒子的绘制顺序。相当于 :ref:`GPUParticles3D.draw_order`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_draw_pass_mesh: .. rst-class:: classref-method |void| **particles_set_draw_pass_mesh**\ (\ particles\: :ref:`RID`, pass\: :ref:`int`, mesh\: :ref:`RID`\ ) :ref:`🔗` 设置用于指定绘制阶段的网格。相当于 :ref:`GPUParticles3D.draw_pass_1`\ 、\ :ref:`GPUParticles3D.draw_pass_2`\ 、\ :ref:`GPUParticles3D.draw_pass_3` 和 :ref:`GPUParticles3D.draw_pass_4`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_draw_passes: .. rst-class:: classref-method |void| **particles_set_draw_passes**\ (\ particles\: :ref:`RID`, count\: :ref:`int`\ ) :ref:`🔗` 设置要使用的绘制阶段的数量。相当于 :ref:`GPUParticles3D.draw_passes`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_emission_transform: .. rst-class:: classref-method |void| **particles_set_emission_transform**\ (\ particles\: :ref:`RID`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` 设置粒子首次发射时使用的 :ref:`Transform3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_emitter_velocity: .. rst-class:: classref-method |void| **particles_set_emitter_velocity**\ (\ particles\: :ref:`RID`, velocity\: :ref:`Vector3`\ ) :ref:`🔗` 设置粒子节点的速度，将由 :ref:`ParticleProcessMaterial.inherit_velocity_ratio` 使用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_emitting: .. rst-class:: classref-method |void| **particles_set_emitting**\ (\ particles\: :ref:`RID`, emitting\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则粒子将随时间发射。设置为 ``false`` 不会重置粒子，只会停止发射。等价于 :ref:`GPUParticles3D.emitting`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_explosiveness_ratio: .. rst-class:: classref-method |void| **particles_set_explosiveness_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) :ref:`🔗` 设置爆发比例。相当于 :ref:`GPUParticles3D.explosiveness`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_fixed_fps: .. rst-class:: classref-method |void| **particles_set_fixed_fps**\ (\ particles\: :ref:`RID`, fps\: :ref:`int`\ ) :ref:`🔗` 设置粒子系统渲染的固定帧率。相当于 :ref:`GPUParticles3D.fixed_fps`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_fractional_delta: .. rst-class:: classref-method |void| **particles_set_fractional_delta**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则使用分数增量来平滑粒子的运动。相当于 :ref:`GPUParticles3D.fract_delta`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_interp_to_end: .. rst-class:: classref-method |void| **particles_set_interp_to_end**\ (\ particles\: :ref:`RID`, factor\: :ref:`float`\ ) :ref:`🔗` 设置通知 :ref:`ParticleProcessMaterial` 将所有粒子冲向其生命周期终点的值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_interpolate: .. rst-class:: classref-method |void| **particles_set_interpolate**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_lifetime: .. rst-class:: classref-method |void| **particles_set_lifetime**\ (\ particles\: :ref:`RID`, lifetime\: :ref:`float`\ ) :ref:`🔗` 设置系统中每个粒子的生命周期。相当于 :ref:`GPUParticles3D.lifetime`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_mode: .. rst-class:: classref-method |void| **particles_set_mode**\ (\ particles\: :ref:`RID`, mode\: :ref:`ParticlesMode`\ ) :ref:`🔗` 设置由 RID ``particles`` 指定的 GPU 粒子是否应该根据 ``mode`` 在 2D 或 3D 中渲染。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_one_shot: .. rst-class:: classref-method |void| **particles_set_one_shot**\ (\ particles\: :ref:`RID`, one_shot\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则粒子将发射一次然后停止。相当于 :ref:`GPUParticles3D.one_shot`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_pre_process_time: .. rst-class:: classref-method |void| **particles_set_pre_process_time**\ (\ particles\: :ref:`RID`, time\: :ref:`float`\ ) :ref:`🔗` 设置粒子动画的预处理时间。这样可以让动画延迟到粒子开始发射之后再开始。相当于 :ref:`GPUParticles3D.preprocess`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_process_material: .. rst-class:: classref-method |void| **particles_set_process_material**\ (\ particles\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` 设置用于处理粒子的材质。 \ **注意：**\ 这不是用来绘制材质的材质。相当于 :ref:`GPUParticles3D.process_material`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_randomness_ratio: .. rst-class:: classref-method |void| **particles_set_randomness_ratio**\ (\ particles\: :ref:`RID`, ratio\: :ref:`float`\ ) :ref:`🔗` 设置发射随机性比例。会随机化该粒子在其相位内的发射。相当于 :ref:`GPUParticles3D.randomness`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_speed_scale: .. rst-class:: classref-method |void| **particles_set_speed_scale**\ (\ particles\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` 设置粒子系统的速度缩放。相当于 :ref:`GPUParticles3D.speed_scale`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_subemitter: .. rst-class:: classref-method |void| **particles_set_subemitter**\ (\ particles\: :ref:`RID`, subemitter_particles\: :ref:`RID`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_trail_bind_poses: .. rst-class:: classref-method |void| **particles_set_trail_bind_poses**\ (\ particles\: :ref:`RID`, bind_poses\: :ref:`Array`\[:ref:`Transform3D`\]\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_trails: .. rst-class:: classref-method |void| **particles_set_trails**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`, length_sec\: :ref:`float`\ ) :ref:`🔗` 如果 ``enable`` 为 ``true``\ ，则会为 ``particles`` 启用尾迹，长度为 ``length_sec`` 秒。等价于 :ref:`GPUParticles3D.trail_enabled` 和 :ref:`GPUParticles3D.trail_lifetime`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_transform_align: .. rst-class:: classref-method |void| **particles_set_transform_align**\ (\ particles\: :ref:`RID`, align\: :ref:`ParticlesTransformAlign`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_use_local_coordinates: .. rst-class:: classref-method |void| **particles_set_use_local_coordinates**\ (\ particles\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则粒子使用局部坐标。如果为 ``false`` 则使用全局坐标。相当于 :ref:`GPUParticles3D.local_coords`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_positional_soft_shadow_filter_set_quality: .. rst-class:: classref-method |void| **positional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality`\ ) :ref:`🔗` 设置 3D 全向灯和聚光灯阴影的过滤质量。另见 :ref:`ProjectSettings.rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality`\ 。这个参数是全局的，无法针对单个视口设置。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_create: .. rst-class:: classref-method :ref:`RID` **reflection_probe_create**\ (\ ) :ref:`🔗` 创建反射探针并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``reflection_probe_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 如果要将这个反射探针放置到场景中，请使用返回的 RID 调用 :ref:`instance_set_base()`\ ，将其附加至某个实例上。 \ **注意：**\ 等价节点为 :ref:`ReflectionProbe`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_ambient_color: .. rst-class:: classref-method |void| **reflection_probe_set_ambient_color**\ (\ probe\: :ref:`RID`, color\: :ref:`Color`\ ) :ref:`🔗` 设置反射探针的自定义环境光颜色。等价于 :ref:`ReflectionProbe.ambient_color`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_ambient_energy: .. rst-class:: classref-method |void| **reflection_probe_set_ambient_energy**\ (\ probe\: :ref:`RID`, energy\: :ref:`float`\ ) :ref:`🔗` 设置反射探针的自定义环境光能量。等价于 :ref:`ReflectionProbe.ambient_color_energy`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_ambient_mode: .. rst-class:: classref-method |void| **reflection_probe_set_ambient_mode**\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeAmbientMode`\ ) :ref:`🔗` 设置反射探针的环境光模式。等价于 :ref:`ReflectionProbe.ambient_mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_as_interior: .. rst-class:: classref-method |void| **reflection_probe_set_as_interior**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则反射将忽略天空的贡献。相当于 :ref:`ReflectionProbe.interior`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_blend_distance: .. rst-class:: classref-method |void| **reflection_probe_set_blend_distance**\ (\ probe\: :ref:`RID`, blend_distance\: :ref:`float`\ ) :ref:`🔗` 设置探针与场景融合的距离，单位为米。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_cull_mask: .. rst-class:: classref-method |void| **reflection_probe_set_cull_mask**\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` 设置该反射探针的渲染剔除掩码。只有具有匹配层的实例才会被该探针反射。相当于 :ref:`ReflectionProbe.cull_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_enable_box_projection: .. rst-class:: classref-method |void| **reflection_probe_set_enable_box_projection**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则使用箱体投影。这可以使反射在某些情况下看起来更正确。相当于 :ref:`ReflectionProbe.box_projection`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_enable_shadows: .. rst-class:: classref-method |void| **reflection_probe_set_enable_shadows**\ (\ probe\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，计算反射探针中的阴影。这会使得反射的计算速度慢得多。相当于 :ref:`ReflectionProbe.enable_shadows`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_intensity: .. rst-class:: classref-method |void| **reflection_probe_set_intensity**\ (\ probe\: :ref:`RID`, intensity\: :ref:`float`\ ) :ref:`🔗` 设置反射探针的强度。强度调节反射的强度。相当于 :ref:`ReflectionProbe.intensity`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_max_distance: .. rst-class:: classref-method |void| **reflection_probe_set_max_distance**\ (\ probe\: :ref:`RID`, distance\: :ref:`float`\ ) :ref:`🔗` 设置物体在被删除前与探针的最大距离。相当于 :ref:`ReflectionProbe.max_distance`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold: .. rst-class:: classref-method |void| **reflection_probe_set_mesh_lod_threshold**\ (\ probe\: :ref:`RID`, pixels\: :ref:`float`\ ) :ref:`🔗` 设置渲染反射探针时所使用的网格细节级别。值越高，生成了 LOD 变体的网格所使用的版本细节就越低，能够提升性能。等价于 :ref:`ReflectionProbe.mesh_lod_threshold`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_origin_offset: .. rst-class:: classref-method |void| **reflection_probe_set_origin_offset**\ (\ probe\: :ref:`RID`, offset\: :ref:`Vector3`\ ) :ref:`🔗` 设置当此反射探针处于框项目模式时要使用的源偏移。相当于 :ref:`ReflectionProbe.origin_offset`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_reflection_mask: .. rst-class:: classref-method |void| **reflection_probe_set_reflection_mask**\ (\ probe\: :ref:`RID`, layers\: :ref:`int`\ ) :ref:`🔗` 设置该反射探针的渲染反射掩码。只有具有匹配层的实例才会被该探针应用反射。相当于 :ref:`ReflectionProbe.reflection_mask`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_resolution: .. rst-class:: classref-method |void| **reflection_probe_set_resolution**\ (\ probe\: :ref:`RID`, resolution\: :ref:`int`\ ) :ref:`🔗` **已弃用：** This method has not done anything since Godot 3. 已弃用。该方法什么也不做。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_size: .. rst-class:: classref-method |void| **reflection_probe_set_size**\ (\ probe\: :ref:`RID`, size\: :ref:`Vector3`\ ) :ref:`🔗` 设置反射探针将捕获的区域的大小。相当于 :ref:`ReflectionProbe.size`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_update_mode: .. rst-class:: classref-method |void| **reflection_probe_set_update_mode**\ (\ probe\: :ref:`RID`, mode\: :ref:`ReflectionProbeUpdateMode`\ ) :ref:`🔗` 设置反射探针的更新频率。可以是一次，也可以是每一帧。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_request_frame_drawn_callback: .. rst-class:: classref-method |void| **request_frame_drawn_callback**\ (\ callable\: :ref:`Callable`\ ) :ref:`🔗` 安排对给定可调用体的回调，会在一帧绘制完成后回调。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_create: .. rst-class:: classref-method :ref:`RID` **scenario_create**\ (\ ) :ref:`🔗` 创建场景并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``scenario_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 场景是所有可视实例存在的 3D 世界。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_set_camera_attributes: .. rst-class:: classref-method |void| **scenario_set_camera_attributes**\ (\ scenario\: :ref:`RID`, effects\: :ref:`RID`\ ) :ref:`🔗` 设置该场景会使用的相机属性（\ ``effects``\ ）。另见 :ref:`CameraAttributes`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_set_compositor: .. rst-class:: classref-method |void| **scenario_set_compositor**\ (\ scenario\: :ref:`RID`, compositor\: :ref:`RID`\ ) :ref:`🔗` 设置将被用于该场景的合成器（\ ``compositor``\ ）。另见 :ref:`Compositor`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_set_environment: .. rst-class:: classref-method |void| **scenario_set_environment**\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) :ref:`🔗` 设置该场景会使用的环境。另见 :ref:`Environment`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_set_fallback_environment: .. rst-class:: classref-method |void| **scenario_set_fallback_environment**\ (\ scenario\: :ref:`RID`, environment\: :ref:`RID`\ ) :ref:`🔗` 设置此方案所使用的后备环境。如果没有设置环境，则使用后备环境。这被编辑器用来提供一个默认环境。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_screen_space_roughness_limiter_set_active: .. rst-class:: classref-method |void| **screen_space_roughness_limiter_set_active**\ (\ enable\: :ref:`bool`, amount\: :ref:`float`, limit\: :ref:`float`\ ) :ref:`🔗` 设置屏幕空间粗糙度限制参数，例如是否应该启用以及阈值等。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/enabled`\ 、\ :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/amount` 和 :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/limit`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_set_boot_image: .. rst-class:: classref-method |void| **set_boot_image**\ (\ image\: :ref:`Image`, color\: :ref:`Color`, scale\: :ref:`bool`, use_filter\: :ref:`bool` = true\ ) :ref:`🔗` **已弃用：** Use :ref:`set_boot_image_with_stretch()` instead. Sets a boot image. The ``color`` defines the background color. The value of ``scale`` indicates if the image will be scaled to fit the screen size. If ``use_filter`` is ``true``, the image will be scaled with linear interpolation. If ``use_filter`` is ``false``, the image will be scaled with nearest-neighbor interpolation. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_set_boot_image_with_stretch: .. rst-class:: classref-method |void| **set_boot_image_with_stretch**\ (\ image\: :ref:`Image`, color\: :ref:`Color`, stretch_mode\: :ref:`SplashStretchMode`, use_filter\: :ref:`bool` = true\ ) :ref:`🔗` Sets a boot image. The ``color`` defines the background color. The value of ``stretch_mode`` indicates how the image will be stretched (see :ref:`SplashStretchMode` for possible values). If ``use_filter`` is ``true``, the image will be scaled with linear interpolation. If ``use_filter`` is ``false``, the image will be scaled with nearest-neighbor interpolation. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_set_debug_generate_wireframes: .. rst-class:: classref-method |void| **set_debug_generate_wireframes**\ (\ generate\: :ref:`bool`\ ) :ref:`🔗` 如果 ``generate`` 为 ``true``\ ，则在使用 Compatibility 渲染器时会为所有加载的网格生成调试线框。默认情况下，引擎在运行时不会生成调试线框，因为这会减慢资产加载速度并占用显存。 \ **注意：**\ 使用 Compatibility 渲染器时，必须在加载任何网格之前调用此方法，否则将不会使用线框。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_set_default_clear_color: .. rst-class:: classref-method |void| **set_default_clear_color**\ (\ color\: :ref:`Color`\ ) :ref:`🔗` 设置默认清屏颜色，会在尚未选择特定的清屏颜色时使用。另见 :ref:`get_default_clear_color()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_create: .. rst-class:: classref-method :ref:`RID` **shader_create**\ (\ ) :ref:`🔗` 创建空的着色器并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``shader_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价资源为 :ref:`Shader`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_get_code: .. rst-class:: classref-method :ref:`String` **shader_get_code**\ (\ shader\: :ref:`RID`\ ) |const| :ref:`🔗` 以字符串形式返回着色器的源代码。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_get_default_texture_parameter: .. rst-class:: classref-method :ref:`RID` **shader_get_default_texture_parameter**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, index\: :ref:`int` = 0\ ) |const| :ref:`🔗` 返回着色器中的默认纹理，根据名称搜索。 \ **注意：**\ 如果使用了采样器数组，请使用 ``index`` 访问指定的纹理。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_get_parameter_default: .. rst-class:: classref-method :ref:`Variant` **shader_get_parameter_default**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`\ ) |const| :ref:`🔗` 返回指定着色器 Uniform 的默认值。通常是着色器源代码中编写的值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_set_code: .. rst-class:: classref-method |void| **shader_set_code**\ (\ shader\: :ref:`RID`, code\: :ref:`String`\ ) :ref:`🔗` 设置着色器的源代码（更改后会触发重新编译）。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_set_default_texture_parameter: .. rst-class:: classref-method |void| **shader_set_default_texture_parameter**\ (\ shader\: :ref:`RID`, name\: :ref:`StringName`, texture\: :ref:`RID`, index\: :ref:`int` = 0\ ) :ref:`🔗` 设置着色器的默认纹理。覆盖给定名称的纹理。 \ **注意：**\ 使用采样器数组时，使用 ``index`` 访问指定的纹理。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_set_path_hint: .. rst-class:: classref-method |void| **shader_set_path_hint**\ (\ shader\: :ref:`RID`, path\: :ref:`String`\ ) :ref:`🔗` 设置指定着色器路径提示。一般应该与 :ref:`Shader` 资源的 :ref:`Resource.resource_path` 相匹配。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_allocate_data: .. rst-class:: classref-method |void| **skeleton_allocate_data**\ (\ skeleton\: :ref:`RID`, bones\: :ref:`int`, is_2d_skeleton\: :ref:`bool` = false\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_bone_get_transform: .. rst-class:: classref-method :ref:`Transform3D` **skeleton_bone_get_transform**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| :ref:`🔗` 返回该骨架中指定骨骼的 :ref:`Transform3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_bone_get_transform_2d: .. rst-class:: classref-method :ref:`Transform2D` **skeleton_bone_get_transform_2d**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`\ ) |const| :ref:`🔗` 返回该骨架中指定骨骼的 :ref:`Transform2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_bone_set_transform: .. rst-class:: classref-method |void| **skeleton_bone_set_transform**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform3D`\ ) :ref:`🔗` 设置该骨架中指定骨骼的 :ref:`Transform3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_bone_set_transform_2d: .. rst-class:: classref-method |void| **skeleton_bone_set_transform_2d**\ (\ skeleton\: :ref:`RID`, bone\: :ref:`int`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 设置该骨架中指定骨骼的 :ref:`Transform2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_create: .. rst-class:: classref-method :ref:`RID` **skeleton_create**\ (\ ) :ref:`🔗` 创建骨架并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``skeleton_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_get_bone_count: .. rst-class:: classref-method :ref:`int` **skeleton_get_bone_count**\ (\ skeleton\: :ref:`RID`\ ) |const| :ref:`🔗` 返回分配给这个骨架的骨骼数量。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_set_base_transform_2d: .. rst-class:: classref-method |void| **skeleton_set_base_transform_2d**\ (\ skeleton\: :ref:`RID`, base_transform\: :ref:`Transform2D`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_bake_panorama: .. rst-class:: classref-method :ref:`Image` **sky_bake_panorama**\ (\ sky\: :ref:`RID`, energy\: :ref:`float`, bake_irradiance\: :ref:`bool`, size\: :ref:`Vector2i`\ ) :ref:`🔗` Generates and returns an :ref:`Image` containing the radiance map for the specified ``sky`` RID. This supports built-in sky material and custom sky shaders. If ``bake_irradiance`` is ``true``, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also :ref:`environment_bake_panorama()`. \ **Note:** The image is saved using linear encoding without any tonemapping performed, which means it will look too dark if viewed directly in an image editor. ``energy`` values above ``1.0`` can be used to brighten the resulting image. \ **Note:** ``size`` should be a 2:1 aspect ratio for the generated panorama to have square pixels. For radiance maps, there is no point in using a height greater than :ref:`Sky.radiance_size`, as it won't increase detail. Irradiance maps only contain low-frequency data, so there is usually no point in going past a size of 128×64 pixels when saving an irradiance map. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_create: .. rst-class:: classref-method :ref:`RID` **sky_create**\ (\ ) :ref:`🔗` 创建空的天空并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``sky_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_set_material: .. rst-class:: classref-method |void| **sky_set_material**\ (\ sky\: :ref:`RID`, material\: :ref:`RID`\ ) :ref:`🔗` 设置天空用于渲染背景和反射贴图的材质。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_set_mode: .. rst-class:: classref-method |void| **sky_set_mode**\ (\ sky\: :ref:`RID`, mode\: :ref:`SkyMode`\ ) :ref:`🔗` 设置 RID 为 ``sky`` 的天空的处理模式 ``mode``\ 。等价于 :ref:`Sky.process_mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_set_radiance_size: .. rst-class:: classref-method |void| **sky_set_radiance_size**\ (\ sky\: :ref:`RID`, radiance_size\: :ref:`int`\ ) :ref:`🔗` 设置 RID 为 ``sky`` 的天空的辐射率大小 ``radiance_size``\ （单位为像素）。等价于 :ref:`Sky.radiance_size`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_spot_light_create: .. rst-class:: classref-method :ref:`RID` **spot_light_create**\ (\ ) :ref:`🔗` 创建聚光灯并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在大多数 ``light_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 如果要将这个聚光灯放置到场景中，请使用返回的 RID 调用 :ref:`instance_set_base()`\ ，将其附加至某个实例上。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sub_surface_scattering_set_quality: .. rst-class:: classref-method |void| **sub_surface_scattering_set_quality**\ (\ quality\: :ref:`SubSurfaceScatteringQuality`\ ) :ref:`🔗` 设置渲染启用了次表面散射的材质时使用的 :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_quality`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sub_surface_scattering_set_scale: .. rst-class:: classref-method |void| **sub_surface_scattering_set_scale**\ (\ scale\: :ref:`float`, depth_scale\: :ref:`float`\ ) :ref:`🔗` 设置渲染启用了次表面散射的材质时使用的 :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_scale` 和 :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_create: .. rst-class:: classref-method :ref:`RID` **texture_2d_create**\ (\ image\: :ref:`Image`\ ) :ref:`🔗` 创建二维纹理并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``texture_2d_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价资源为 :ref:`Texture2D`\ 。 \ **注意：**\ 请勿与 :ref:`RenderingDevice.texture_create()` 混淆，后者创建的是图形 API 自己的纹理类型，并非 Godot 专属的 :ref:`Texture2D` 资源。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_get: .. rst-class:: classref-method :ref:`Image` **texture_2d_get**\ (\ texture\: :ref:`RID`\ ) |const| :ref:`🔗` 根据给定的纹理 :ref:`RID` ``texture`` 返回 :ref:`Image` 实例。 \ **示例：**\ 从 :ref:`get_test_texture()` 获取测试纹理并将其应用至 :ref:`Sprite2D` 节点： :: var texture_rid = RenderingServer.get_test_texture() var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid)) $Sprite2D.texture = texture .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_layer_get: .. rst-class:: classref-method :ref:`Image` **texture_2d_layer_get**\ (\ texture\: :ref:`RID`, layer\: :ref:`int`\ ) |const| :ref:`🔗` 返回给定 ``texture`` :ref:`RID` 和 ``layer`` 中的 :ref:`Image` 实例。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_layered_create: .. rst-class:: classref-method :ref:`RID` **texture_2d_layered_create**\ (\ layers\: :ref:`Array`\[:ref:`Image`\], layered_type\: :ref:`TextureLayeredType`\ ) :ref:`🔗` 创建二维多层纹理并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``texture_2d_layered_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价资源为 :ref:`TextureLayered`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_layered_placeholder_create: .. rst-class:: classref-method :ref:`RID` **texture_2d_layered_placeholder_create**\ (\ layered_type\: :ref:`TextureLayeredType`\ ) :ref:`🔗` 创建二维多层纹理的占位符并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``texture_2d_layered_*`` RenderingServer 函数中使用，但使用时什么都不会发生。另见 :ref:`texture_2d_placeholder_create()`\ 。 \ **注意：**\ 等价资源为 :ref:`PlaceholderTextureLayered`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_placeholder_create: .. rst-class:: classref-method :ref:`RID` **texture_2d_placeholder_create**\ (\ ) :ref:`🔗` 创建二维多层纹理的占位符并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``texture_2d_layered_*`` RenderingServer 函数中使用，但使用时什么都不会发生。另见 :ref:`texture_2d_layered_placeholder_create()`\ 。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价资源为 :ref:`PlaceholderTexture2D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_update: .. rst-class:: classref-method |void| **texture_2d_update**\ (\ texture\: :ref:`RID`, image\: :ref:`Image`, layer\: :ref:`int`\ ) :ref:`🔗` 使用 ``image`` 中的数据更新由纹理 :ref:`RID` ``texture`` 指定的纹理。\ ``layer`` 也必须指定，更新单层纹理（\ :ref:`Texture2D`\ ）时应为 ``0``\ 。 \ **注意：**\ ``image`` 的宽度、高度、格式都必须和当前 ``texture`` 的数据相同。否则会输出错误，不会修改原始纹理。如果你需要使用不同的宽度、高度或格式，请改用 :ref:`texture_replace()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_3d_create: .. rst-class:: classref-method :ref:`RID` **texture_3d_create**\ (\ format\: :ref:`Format`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, mipmaps\: :ref:`bool`, data\: :ref:`Array`\[:ref:`Image`\]\ ) :ref:`🔗` **注意：**\ 等价的资源是 :ref:`Texture3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_3d_get: .. rst-class:: classref-method :ref:`Array`\[:ref:`Image`\] **texture_3d_get**\ (\ texture\: :ref:`RID`\ ) |const| :ref:`🔗` 以 :ref:`Image` 数组的形式返回指定纹理 :ref:`RID` 的 3D 纹理数据。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_3d_placeholder_create: .. rst-class:: classref-method :ref:`RID` **texture_3d_placeholder_create**\ (\ ) :ref:`🔗` 创建三维纹理的占位符并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``texture_3d_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价资源为 :ref:`PlaceholderTexture3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_3d_update: .. rst-class:: classref-method |void| **texture_3d_update**\ (\ texture\: :ref:`RID`, data\: :ref:`Array`\[:ref:`Image`\]\ ) :ref:`🔗` 使用 ``data`` 中的数据更新由纹理 :ref:`RID` ``texture`` 指定的纹理。必须同时更新所有纹理层。 \ **注意：**\ ``texture`` 的宽度、高度、格式都必须和当前纹理数据相同。否则会输出错误，不会修改原始纹理。如果你需要使用不同的宽度、高度或格式，请改用 :ref:`texture_replace()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_create_from_native_handle: .. rst-class:: classref-method :ref:`RID` **texture_create_from_native_handle**\ (\ type\: :ref:`TextureType`, format\: :ref:`Format`, native_handle\: :ref:`int`, width\: :ref:`int`, height\: :ref:`int`, depth\: :ref:`int`, layers\: :ref:`int` = 1, layered_type\: :ref:`TextureLayeredType` = 0\ ) :ref:`🔗` Creates a texture based on a native handle that was created outside of Godot's renderer. \ **Note:** If using only the rendering device renderer, it's recommend to use :ref:`RenderingDevice.texture_create_from_extension()` together with :ref:`texture_rd_create()`, rather than this method. This way, the texture's format and usage can be controlled more effectively. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_get_format: .. rst-class:: classref-method :ref:`Format` **texture_get_format**\ (\ texture\: :ref:`RID`\ ) |const| :ref:`🔗` 返回该纹理的格式。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_get_native_handle: .. rst-class:: classref-method :ref:`int` **texture_get_native_handle**\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension. \ ``srgb`` should be ``true`` when the texture uses nonlinear sRGB encoding and ``false`` when the texture uses linear encoding. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan). .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_get_path: .. rst-class:: classref-method :ref:`String` **texture_get_path**\ (\ texture\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_get_rd_texture: .. rst-class:: classref-method :ref:`RID` **texture_get_rd_texture**\ (\ texture\: :ref:`RID`, srgb\: :ref:`bool` = false\ ) |const| :ref:`🔗` Returns a texture :ref:`RID` that can be used with :ref:`RenderingDevice`. \ ``srgb`` should be ``true`` when the texture uses nonlinear sRGB encoding and ``false`` when the texture uses linear encoding. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_proxy_create: .. rst-class:: classref-method :ref:`RID` **texture_proxy_create**\ (\ base\: :ref:`RID`\ ) :ref:`🔗` **已弃用：** ProxyTexture was removed in Godot 4. 这个方法不起任何作用，始终返回无效的 :ref:`RID`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_proxy_update: .. rst-class:: classref-method |void| **texture_proxy_update**\ (\ texture\: :ref:`RID`, proxy_to\: :ref:`RID`\ ) :ref:`🔗` **已弃用：** ProxyTexture was removed in Godot 4. 这个方法什么也不做。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_rd_create: .. rst-class:: classref-method :ref:`RID` **texture_rd_create**\ (\ rd_texture\: :ref:`RID`, layer_type\: :ref:`TextureLayeredType` = 0\ ) :ref:`🔗` Creates a new texture object based on a texture created directly on the :ref:`RenderingDevice`. If the texture contains layers, ``layer_type`` is used to define the layer type. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid()` method. \ **Note:** The RenderingServer's :ref:`free_rid()` won't free the underlying ``rd_texture``, you will want to free the ``rd_texture`` using :ref:`RenderingDevice.free_rid()`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_replace: .. rst-class:: classref-method |void| **texture_replace**\ (\ texture\: :ref:`RID`, by_texture\: :ref:`RID`\ ) :ref:`🔗` 将 ``texture`` 的纹理数据替换为由纹理 RID ``by_texture`` 指定的纹理，不会改变 ``texture`` 的 RID。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_set_force_redraw_if_visible: .. rst-class:: classref-method |void| **texture_set_force_redraw_if_visible**\ (\ texture\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_set_path: .. rst-class:: classref-method |void| **texture_set_path**\ (\ texture\: :ref:`RID`, path\: :ref:`String`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_set_size_override: .. rst-class:: classref-method |void| **texture_set_size_override**\ (\ texture\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_attach_camera: .. rst-class:: classref-method |void| **viewport_attach_camera**\ (\ viewport\: :ref:`RID`, camera\: :ref:`RID`\ ) :ref:`🔗` 设置视图的相机。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_attach_canvas: .. rst-class:: classref-method |void| **viewport_attach_canvas**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) :ref:`🔗` 设置视口的画布。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_attach_to_screen: .. rst-class:: classref-method |void| **viewport_attach_to_screen**\ (\ viewport\: :ref:`RID`, rect\: :ref:`Rect2` = Rect2(0, 0, 0, 0), screen\: :ref:`int` = 0\ ) :ref:`🔗` 将该视口复制到 ``rect`` 指定的屏幕区域。如果 :ref:`viewport_set_render_direct_to_screen()` 为 ``true``\ ，则视口不使用帧缓冲区，视口的内容将直接渲染到屏幕。但是，请注意根视口是最后绘制的，因此它会覆盖屏幕。相应地，必须将根视口的区域设置为不覆盖附加该视口的区域。 例如，可以使用以下代码将根视口设置为完全不渲染： .. tabs:: .. code-tab:: gdscript func _ready(): RenderingServer.viewport_attach_to_screen(get_viewport().get_viewport_rid(), Rect2()) RenderingServer.viewport_attach_to_screen($Viewport.get_viewport_rid(), Rect2(0, 0, 600, 600)) 使用它可以带来显著的优化，尤其是在低端设备上。但是，这是以必须手动管理视口为代价的。进一步优化请参见 :ref:`viewport_set_render_direct_to_screen()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_create: .. rst-class:: classref-method :ref:`RID` **viewport_create**\ (\ ) :ref:`🔗` 创建空的视口并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``viewport_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价节点为 :ref:`Viewport`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_measured_render_time_cpu: .. rst-class:: classref-method :ref:`float` **viewport_get_measured_render_time_cpu**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` 返回渲染上一帧所消耗的 CPU 时间，单位为毫秒。\ *只包含*\ 渲染相关操作所消耗的时间；读数中不含脚本的 ``_process`` 函数及其他引擎子系统。要获取渲染场景所消耗 CPU 时间的完整读数，请将每帧绘制的所有视口的渲染时间以及 :ref:`get_frame_setup_time_cpu()` 相加。与 :ref:`Engine.get_frames_per_second()` 不同，即便帧率受到垂直同步或 :ref:`Engine.max_fps` 的限制，这个方法也会精确反映 CPU 利用率。另见 :ref:`viewport_get_measured_render_time_gpu()`\ 。 \ **注意：**\ 需要使用 :ref:`viewport_set_measure_render_time()` 启用 ``viewport`` 的测量。否则这个方法会返回 ``0.0``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu: .. rst-class:: classref-method :ref:`float` **viewport_get_measured_render_time_gpu**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` 返回渲染上一帧所消耗的 GPU 时间，单位为毫秒。要获取渲染场景所消耗 GPU 时间的完整读数，请将每帧绘制的所有视口的渲染时间相加。与 :ref:`Engine.get_frames_per_second()` 不同，即便帧率受到垂直同步或 :ref:`Engine.max_fps` 的限制，这个方法也会精确反映 GPU 利用率。另见 :ref:`viewport_get_measured_render_time_cpu()`\ 。 \ **注意：**\ 需要使用 :ref:`viewport_set_measure_render_time()` 启用 ``viewport`` 的测量。否则这个方法会返回 ``0.0``\ 。 \ **注意：**\ GPU 的利用率在一段时间内低到一定程度时，GPU 会降低电源状态（导致内核与内存时钟速度的降低）。这会导致 GPU 在某个帧率下保持较低利用率时，汇报的 GPU 时间增大（相对于 GPU 的最高电源状态而言）。请在使用 :ref:`viewport_get_measured_render_time_gpu()` 进行性能测试时牢记这一点。可以在显卡驱动的设置中改变这种行为，但代价是耗电量增大。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_render_info: .. rst-class:: classref-method :ref:`int` **viewport_get_render_info**\ (\ viewport\: :ref:`RID`, type\: :ref:`ViewportRenderInfoType`, info\: :ref:`ViewportRenderInfo`\ ) :ref:`🔗` 返回关于渲染引擎的统计信息，能够用于性能分析。会区分不同的渲染阶段类型 ``type``\ ，每种类型都有相同的可查询信息 ``info``\ （不同的阶段会返回不同的值）。 另见 :ref:`get_rendering_info()`\ ，返回的是所有视口的全局信息。 \ **注意：**\ 引擎渲染至少 2 帧后渲染信息才可用。渲染信息不可用时 :ref:`viewport_get_render_info()` 返回 ``0``\ 。要在 ``_ready()`` 中成功输出渲染信息，请使用如下代码： :: func _ready(): for _i in 2: await get_tree().process_frame print( RenderingServer.viewport_get_render_info(get_viewport().get_viewport_rid(), RenderingServer.VIEWPORT_RENDER_INFO_TYPE_VISIBLE, RenderingServer.VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME) ) .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_render_target: .. rst-class:: classref-method :ref:`RID` **viewport_get_render_target**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` 返回该视口的渲染目标。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_texture: .. rst-class:: classref-method :ref:`RID` **viewport_get_texture**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` 返回视口的最后渲染帧。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_update_mode: .. rst-class:: classref-method :ref:`ViewportUpdateMode` **viewport_get_update_mode**\ (\ viewport\: :ref:`RID`\ ) |const| :ref:`🔗` 返回视口的更新模式。 \ **警告：**\ 在渲染线程之外的线程调用该方法会损害性能。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_remove_canvas: .. rst-class:: classref-method |void| **viewport_remove_canvas**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`\ ) :ref:`🔗` 从画布分离视口。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_active: .. rst-class:: classref-method |void| **viewport_set_active**\ (\ viewport\: :ref:`RID`, active\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则将视口设置为活动状态，否则将其设置为非活动状态。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_anisotropic_filtering_level: .. rst-class:: classref-method |void| **viewport_set_anisotropic_filtering_level**\ (\ viewport\: :ref:`RID`, anisotropic_filtering_level\: :ref:`ViewportAnisotropicFiltering`\ ) :ref:`🔗` 设置在纹理上使用各向异性过滤时要采用的最大样本数（作为 2 的幂）。更高的采样数将导致倾斜角度的纹理更清晰，但计算成本更高。\ ``0`` 的值会强制禁用各向异性过滤，即使在启用它的材质上也是如此。 如果贴花和投影器被配置为使用各向异性过滤，则各向异性过滤级别也会影响它们。见 :ref:`ProjectSettings.rendering/textures/decals/filter` and :ref:`ProjectSettings.rendering/textures/light_projectors/filter`\ 。 \ **注意：**\ 要使该设置在 3D 中生效，请在材质上将 :ref:`BaseMaterial3D.texture_filter` 设置为 :ref:`BaseMaterial3D.TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC` 或 :ref:`BaseMaterial3D.TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC`\ 。 \ **注意：**\ 要使该设置在 2D 中生效，请在显示纹理的 :ref:`CanvasItem` 节点上（或 :ref:`CanvasTexture` 中）将 :ref:`CanvasItem.texture_filter` 设置为 :ref:`CanvasItem.TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC` 或 :ref:`CanvasItem.TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC`\ 。然而各向异性过滤在 2D 中并不实用，因此在 2D 中只有在它产生有意义的视觉差异时才对纹理启用它。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_canvas_cull_mask: .. rst-class:: classref-method |void| **viewport_set_canvas_cull_mask**\ (\ viewport\: :ref:`RID`, canvas_cull_mask\: :ref:`int`\ ) :ref:`🔗` 设置与此 :ref:`Viewport` 关联的渲染掩码。渲染可见层与之匹配的 :ref:`CanvasItem` 节点才会被此 :ref:`Viewport` 渲染。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_canvas_stacking: .. rst-class:: classref-method |void| **viewport_set_canvas_stacking**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, layer\: :ref:`int`, sublayer\: :ref:`int`\ ) :ref:`🔗` 设置视口画布的堆叠顺序。 \ ``layer`` 是实际的画布层，而 ``sublayer`` 指定的是该画布在同一层中的堆叠顺序。 \ **注意：**\ ``layer`` 应在 :ref:`CANVAS_LAYER_MIN` 和 :ref:`CANVAS_LAYER_MAX` 之间（含两端）。其他值都会发生环绕。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_canvas_transform: .. rst-class:: classref-method |void| **viewport_set_canvas_transform**\ (\ viewport\: :ref:`RID`, canvas\: :ref:`RID`, offset\: :ref:`Transform2D`\ ) :ref:`🔗` 设置视口画布的变换。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_clear_mode: .. rst-class:: classref-method |void| **viewport_set_clear_mode**\ (\ viewport\: :ref:`RID`, clear_mode\: :ref:`ViewportClearMode`\ ) :ref:`🔗` 设置视口的清空模式。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_debug_draw: .. rst-class:: classref-method |void| **viewport_set_debug_draw**\ (\ viewport\: :ref:`RID`, draw\: :ref:`ViewportDebugDraw`\ ) :ref:`🔗` 设置视口的调试绘图模式。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter: .. rst-class:: classref-method |void| **viewport_set_default_canvas_item_texture_filter**\ (\ viewport\: :ref:`RID`, filter\: :ref:`CanvasItemTextureFilter`\ ) :ref:`🔗` 设置视口的默认纹理过滤模式，视口由 ``viewport`` RID 指定。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat: .. rst-class:: classref-method |void| **viewport_set_default_canvas_item_texture_repeat**\ (\ viewport\: :ref:`RID`, repeat\: :ref:`CanvasItemTextureRepeat`\ ) :ref:`🔗` 设置视口的默认纹理重复模式，视口由 ``viewport`` RID 指定。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_disable_2d: .. rst-class:: classref-method |void| **viewport_set_disable_2d**\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则不渲染视口的画布（即 2D 和 GUI 元素）。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_disable_3d: .. rst-class:: classref-method |void| **viewport_set_disable_3d**\ (\ viewport\: :ref:`RID`, disable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则不渲染视口的 3D 元素。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_environment_mode: .. rst-class:: classref-method |void| **viewport_set_environment_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportEnvironmentMode`\ ) :ref:`🔗` 设置视口的环境模式，该模式允许启用或禁用 2D 画布上的 3D 环境渲染。禁用时，2D 将不受环境影响。启用时，如果环境背景模式为 :ref:`ENV_BG_CANVAS`\ ，则 2D 会受到环境的影响。默认行为是从视口的父级继承设置。如果最顶层的父级也被设置为 :ref:`VIEWPORT_ENVIRONMENT_INHERIT`\ ，则该行为将与设置为 :ref:`VIEWPORT_ENVIRONMENT_ENABLED` 时相同。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_fsr_sharpness: .. rst-class:: classref-method |void| **viewport_set_fsr_sharpness**\ (\ viewport\: :ref:`RID`, sharpness\: :ref:`float`\ ) :ref:`🔗` 决定使用 FSR 放大模式时放大图像的清晰度。每个整数的锐度减半。值从 0.0（最锐利）到 2.0。高于 2.0 的值不会产生明显的差异。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_global_canvas_transform: .. rst-class:: classref-method |void| **viewport_set_global_canvas_transform**\ (\ viewport\: :ref:`RID`, transform\: :ref:`Transform2D`\ ) :ref:`🔗` 设置视口的全局变换矩阵。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_measure_render_time: .. rst-class:: classref-method |void| **viewport_set_measure_render_time**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 为给定的 ``viewport`` RID（使用 :ref:`Viewport.get_viewport_rid()` 获取）设置是否测量。启用后，使用给定的 ``viewport`` 对 :ref:`viewport_get_measured_render_time_cpu()` 和 :ref:`viewport_get_measured_render_time_gpu()` 进行查询返回的就是大于 ``0.0`` 的值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_msaa_2d: .. rst-class:: classref-method |void| **viewport_set_msaa_2d**\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) :ref:`🔗` 设置视口的 2D/画布多重采样抗锯齿模式，视口由 ``viewport`` RID 指定。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_2d` 或 :ref:`Viewport.msaa_2d`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_msaa_3d: .. rst-class:: classref-method |void| **viewport_set_msaa_3d**\ (\ viewport\: :ref:`RID`, msaa\: :ref:`ViewportMSAA`\ ) :ref:`🔗` 设置视口的 3D 多重采样抗锯齿模式，视口由 ``viewport`` RID 指定。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d` 或 :ref:`Viewport.msaa_3d`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality: .. rst-class:: classref-method |void| **viewport_set_occlusion_culling_build_quality**\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality`\ ) :ref:`🔗` 设置遮挡剔除的 :ref:`ProjectSettings.rendering/occlusion_culling/bvh_build_quality`\ 。这个参数是全局的，无法针对特定视口设置。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread: .. rst-class:: classref-method |void| **viewport_set_occlusion_rays_per_thread**\ (\ rays_per_thread\: :ref:`int`\ ) :ref:`🔗` 设置遮挡剔除的 :ref:`ProjectSettings.rendering/occlusion_culling/occlusion_rays_per_thread`\ 。这个参数是全局的，无法针对特定视口设置。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_parent_viewport: .. rst-class:: classref-method |void| **viewport_set_parent_viewport**\ (\ viewport\: :ref:`RID`, parent_viewport\: :ref:`RID`\ ) :ref:`🔗` 将该视口的父项设置为 ``parent_viewport`` RID 指定的视口。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision: .. rst-class:: classref-method |void| **viewport_set_positional_shadow_atlas_quadrant_subdivision**\ (\ viewport\: :ref:`RID`, quadrant\: :ref:`int`, subdivision\: :ref:`int`\ ) :ref:`🔗` 设置全向灯和聚光灯阴影的指定阴影图集象限 ``quadrant`` 的细分次数。另见 :ref:`Viewport.set_positional_shadow_atlas_quadrant_subdiv()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_size: .. rst-class:: classref-method |void| **viewport_set_positional_shadow_atlas_size**\ (\ viewport\: :ref:`RID`, size\: :ref:`int`, use_16_bits\: :ref:`bool` = false\ ) :ref:`🔗` 设置阴影图集图像的大小（用于全向灯和聚光灯），大小由 ``size`` 指定，生效的视口由 ``viewport`` RID 指定。该值将向上舍入到最接近的 2 次幂。如果 ``use_16_bits`` 为 ``true``\ ，则会使用 16 位的全向灯/聚光灯阴影深度贴图。启用后，阴影的精度会降低，可能造成阴影失真，但能够在部分设备上提升性能。 \ **注意：**\ 如果设置为 ``0``\ ，将根本看不到任何阴影。可以通过降低 CPU 和 GPU 负载来显著提升在低端系统上的性能（因为绘制不带阴影的场景需要的绘制调用更少）。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_render_direct_to_screen: .. rst-class:: classref-method |void| **viewport_set_render_direct_to_screen**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则将视口的内容直接渲染到屏幕。这允许一个低级别的优化，可以跳过将视口绘制到根视口。虽然这种优化可以显著提高速度（尤其是在旧设备上），但它是以可用性为代价的。启用后，无法从视口或 screen_texture 读取。而且还会失去某些窗口设置的好处，例如各种拉伸模式。另一个需要注意的后果是，在 2D 中，渲染是以窗口坐标进行的，所以如果有一个两倍于窗口大小的视口，并且设置了这个属性，那么只会绘制适合窗口的部分， 无法自动缩放，即使游戏场景明显大于窗口大小。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_scaling_3d_mode: .. rst-class:: classref-method |void| **viewport_set_scaling_3d_mode**\ (\ viewport\: :ref:`RID`, scaling_3d_mode\: :ref:`ViewportScaling3DMode`\ ) :ref:`🔗` 设置 3D 分辨率缩放模式。双线性缩放使用不同的分辨率渲染，能够对视口进行欠采样或超采样。FidelityFX 超分辨率 1.0，缩写为 FSR，是一种放大技术，通过使用空间感知放大算法以快速帧速率生成高质量图像。FSR 比双线性的开销略大，但产生的图像质量明显更高。应尽可能使用 FSR。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_scaling_3d_scale: .. rst-class:: classref-method |void| **viewport_set_scaling_3d_scale**\ (\ viewport\: :ref:`RID`, scale\: :ref:`float`\ ) :ref:`🔗` 根据视图大小，缩放 3D 渲染缓冲区，使用 :ref:`ViewportScaling3DMode` 中指定的图像过滤器，将输出图像缩放到完整视图大小。低于 ``1.0`` 的值，可用于加速 3D 渲染，但会以质量为代价（欠采样）。大于 ``1.0`` 的值，仅对双线性模式有效，可用于以较高的性能成本（超级采样），提高 3D 渲染质量。另见 :ref:`ViewportMSAA` 以了解多重采样抗锯齿，这要便宜得多，但只会平滑多边形的边缘。 在使用 FSR 放大时，AMD 建议将以下值，作为预设选项公开给用户：“超质量：0.77”、“质量：0.67”、“平衡：0.59”、“性能：0.5”，而不是公开整个比例。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_scenario: .. rst-class:: classref-method |void| **viewport_set_scenario**\ (\ viewport\: :ref:`RID`, scenario\: :ref:`RID`\ ) :ref:`🔗` 设置视口的场景。该场景包含环境、反射图集等信息。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_screen_space_aa: .. rst-class:: classref-method |void| **viewport_set_screen_space_aa**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportScreenSpaceAA`\ ) :ref:`🔗` 设置视口的屏幕空间抗锯齿模式。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa` 和 :ref:`Viewport.screen_space_aa`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale: .. rst-class:: classref-method |void| **viewport_set_sdf_oversize_and_scale**\ (\ viewport\: :ref:`RID`, oversize\: :ref:`ViewportSDFOversize`, scale\: :ref:`ViewportSDFScale`\ ) :ref:`🔗` 设置视口的 2D 带符号距离场的 :ref:`ProjectSettings.rendering/2d/sdf/oversize` 和 :ref:`ProjectSettings.rendering/2d/sdf/scale`\ 。在 :ref:`CanvasItem` 着色器中对带符号距离场进行采样时会用到，\ :ref:`GPUParticles2D` 碰撞时也会用到。3D 渲染时的 SDFGI *不会*\ 使用。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_size: .. rst-class:: classref-method |void| **viewport_set_size**\ (\ viewport\: :ref:`RID`, width\: :ref:`int`, height\: :ref:`int`\ ) :ref:`🔗` 设置视口的宽度和高度，单位为像素。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel: .. rst-class:: classref-method |void| **viewport_set_snap_2d_transforms_to_pixel**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则画布项的变换（即原点的位置）会在渲染时吸附到整像素。这样外观看上去就会更锐利，但会影响移动的平滑程度，尤其是在启用了 :ref:`Camera2D` 平滑的情况下。等价于 :ref:`ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel: .. rst-class:: classref-method |void| **viewport_set_snap_2d_vertices_to_pixel**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则画布项的顶点（即多边形的点）会在渲染时吸附到整像素。这样外观看上去就会更锐利，但会影响移动的平滑程度，尤其是在启用了 :ref:`Camera2D` 平滑的情况下。等价于 :ref:`ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias: .. rst-class:: classref-method |void| **viewport_set_texture_mipmap_bias**\ (\ viewport\: :ref:`RID`, mipmap_bias\: :ref:`float`\ ) :ref:`🔗` 读取较低或较高的 mipmap，影响最终纹理的清晰度（也称为“纹理 LOD 偏置”）。负值会让 mipmap 纹理更锐利，但从较远处观察时颗粒更明显，而正值会让 mipmap 纹理更模糊（即便凑近看也一样）。要在不引入太多颗粒感的情况下，在远处获得更锐利的纹理，请将其设置在 ``-0.75`` 和 ``0.0`` 之间。启用时间抗锯齿（\ :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa`\ ）有助于减少使用负 mipmap 偏置时可见的颗粒度。 \ **注意：**\ 当 3D 缩放模式设置为 FSR 1.0 时，会使用该值调整自动 mipmap 偏置，偏置的计算基于缩放系数。其公式为 ``-log2(1.0 / scale) + mipmap_bias``\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_transparent_background: .. rst-class:: classref-method |void| **viewport_set_transparent_background**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，视口将其背景渲染为透明。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_update_mode: .. rst-class:: classref-method |void| **viewport_set_update_mode**\ (\ viewport\: :ref:`RID`, update_mode\: :ref:`ViewportUpdateMode`\ ) :ref:`🔗` 设置视口应在何时更新。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_debanding: .. rst-class:: classref-method |void| **viewport_set_use_debanding**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 等价于 :ref:`Viewport.use_debanding`\ 。另见 :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_hdr_2d: .. rst-class:: classref-method |void| **viewport_set_use_hdr_2d**\ (\ viewport\: :ref:`RID`, enabled\: :ref:`bool`\ ) :ref:`🔗` 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. This setting has the same effect as :ref:`Viewport.use_hdr_2d`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_occlusion_culling: .. rst-class:: classref-method |void| **viewport_set_use_occlusion_culling**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则在指定的视口上启用遮挡剔除。等价于 :ref:`ProjectSettings.rendering/occlusion_culling/use_occlusion_culling`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_taa: .. rst-class:: classref-method |void| **viewport_set_use_taa**\ (\ viewport\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则在指定的视口上启用时间抗锯齿。等价于 :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa` 或 :ref:`Viewport.use_taa`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_xr: .. rst-class:: classref-method |void| **viewport_set_use_xr**\ (\ viewport\: :ref:`RID`, use_xr\: :ref:`bool`\ ) :ref:`🔗` 如果为 ``true``\ ，则视口使用增强或虚拟现实技术。参阅 :ref:`XRInterface`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_vrs_mode: .. rst-class:: classref-method |void| **viewport_set_vrs_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSMode`\ ) :ref:`🔗` 设置视口的可变速率着色（VRS）模式。如果 GPU 不支持 VRS 则会忽略该属性。等价于 :ref:`ProjectSettings.rendering/vrs/mode`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_vrs_texture: .. rst-class:: classref-method |void| **viewport_set_vrs_texture**\ (\ viewport\: :ref:`RID`, texture\: :ref:`RID`\ ) :ref:`🔗` 当 VRS 模式设置为 :ref:`VIEWPORT_VRS_TEXTURE` 时，要使用的纹理。等价于 :ref:`ProjectSettings.rendering/vrs/texture`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_vrs_update_mode: .. rst-class:: classref-method |void| **viewport_set_vrs_update_mode**\ (\ viewport\: :ref:`RID`, mode\: :ref:`ViewportVRSUpdateMode`\ ) :ref:`🔗` 设置视口的可变速率着色（VRS）更新模式。VRS 要求将输入纹理转换为硬件支持的 VRS 方法可用的格式。更新模式定义这种情况发生的频率。如果 GPU 不支持 VRS，或者未启用 VRS，则忽略该属性。 如果设置为 :ref:`VIEWPORT_VRS_UPDATE_ONCE`\ ，则输入纹理将被复制一次，且模式更改为 :ref:`VIEWPORT_VRS_UPDATE_DISABLED`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_visibility_notifier_create: .. rst-class:: classref-method :ref:`RID` **visibility_notifier_create**\ (\ ) :ref:`🔗` 新建 3D 可见性通知器并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``visibility_notifier_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 如果要将这个网格放置到场景中，请使用返回的 RID 调用 :ref:`instance_set_base()`\ ，将通知器附加至某个实例上。 \ **注意：**\ 等价节点为 :ref:`VisibleOnScreenNotifier3D`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_visibility_notifier_set_aabb: .. rst-class:: classref-method |void| **visibility_notifier_set_aabb**\ (\ notifier\: :ref:`RID`, aabb\: :ref:`AABB`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_visibility_notifier_set_callbacks: .. rst-class:: classref-method |void| **visibility_notifier_set_callbacks**\ (\ notifier\: :ref:`RID`, enter_callable\: :ref:`Callable`, exit_callable\: :ref:`Callable`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_allocate_data: .. rst-class:: classref-method |void| **voxel_gi_allocate_data**\ (\ voxel_gi\: :ref:`RID`, to_cell_xform\: :ref:`Transform3D`, aabb\: :ref:`AABB`, octree_size\: :ref:`Vector3i`, octree_cells\: :ref:`PackedByteArray`, data_cells\: :ref:`PackedByteArray`, distance_field\: :ref:`PackedByteArray`, level_counts\: :ref:`PackedInt32Array`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_create: .. rst-class:: classref-method :ref:`RID` **voxel_gi_create**\ (\ ) :ref:`🔗` 新建基于体素的全局光照对象并将其添加到 RenderingServer。可以通过返回的 RID 进行访问。这个 RID 会在所有 ``voxel_gi_*`` RenderingServer 函数中使用。 RID 使用结束后，应该使用 RenderingServer 的 :ref:`free_rid()` 方法进行释放。 \ **注意：**\ 等价节点为 :ref:`VoxelGI`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_data_cells: .. rst-class:: classref-method :ref:`PackedByteArray` **voxel_gi_get_data_cells**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_distance_field: .. rst-class:: classref-method :ref:`PackedByteArray` **voxel_gi_get_distance_field**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_level_counts: .. rst-class:: classref-method :ref:`PackedInt32Array` **voxel_gi_get_level_counts**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_octree_cells: .. rst-class:: classref-method :ref:`PackedByteArray` **voxel_gi_get_octree_cells**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_octree_size: .. rst-class:: classref-method :ref:`Vector3i` **voxel_gi_get_octree_size**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform: .. rst-class:: classref-method :ref:`Transform3D` **voxel_gi_get_to_cell_xform**\ (\ voxel_gi\: :ref:`RID`\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization: .. rst-class:: classref-method |void| **voxel_gi_set_baked_exposure_normalization**\ (\ voxel_gi\: :ref:`RID`, baked_exposure\: :ref:`float`\ ) :ref:`🔗` 用于通知渲染器烘焙体素 GI 时使用的曝光归一化值。运行时会使用这个值进行调制，确保体素 GI 能够维持恒定的曝光等级，即便场景范围的曝光归一化值在运行时发生改变。更多信息见 :ref:`camera_attributes_set_exposure()`\ 。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_bias: .. rst-class:: classref-method |void| **voxel_gi_set_bias**\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) :ref:`🔗` 为 :ref:`RID` 为 ``voxel_gi`` 的对象设置 :ref:`VoxelGIData.bias` 值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_dynamic_range: .. rst-class:: classref-method |void| **voxel_gi_set_dynamic_range**\ (\ voxel_gi\: :ref:`RID`, range\: :ref:`float`\ ) :ref:`🔗` 为 :ref:`RID` 为 ``voxel_gi`` 的对象设置 :ref:`VoxelGIData.dynamic_range` 值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_energy: .. rst-class:: classref-method |void| **voxel_gi_set_energy**\ (\ voxel_gi\: :ref:`RID`, energy\: :ref:`float`\ ) :ref:`🔗` 为 :ref:`RID` 为 ``voxel_gi`` 的对象设置 :ref:`VoxelGIData.energy` 值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_interior: .. rst-class:: classref-method |void| **voxel_gi_set_interior**\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 为 :ref:`RID` 为 ``voxel_gi`` 的对象设置 :ref:`VoxelGIData.interior` 值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_normal_bias: .. rst-class:: classref-method |void| **voxel_gi_set_normal_bias**\ (\ voxel_gi\: :ref:`RID`, bias\: :ref:`float`\ ) :ref:`🔗` 为 :ref:`RID` 为 ``voxel_gi`` 的对象设置 :ref:`VoxelGIData.normal_bias` 值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_propagation: .. rst-class:: classref-method |void| **voxel_gi_set_propagation**\ (\ voxel_gi\: :ref:`RID`, amount\: :ref:`float`\ ) :ref:`🔗` 为 :ref:`RID` 为 ``voxel_gi`` 的对象设置 :ref:`VoxelGIData.propagation` 值。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_quality: .. rst-class:: classref-method |void| **voxel_gi_set_quality**\ (\ quality\: :ref:`VoxelGIQuality`\ ) :ref:`🔗` 设置渲染时使用的 :ref:`ProjectSettings.rendering/global_illumination/voxel_gi/quality` 值。这个参数是全局的，无法为单独的 VoxelGI 进行设置。 .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces: .. rst-class:: classref-method |void| **voxel_gi_set_use_two_bounces**\ (\ voxel_gi\: :ref:`RID`, enable\: :ref:`bool`\ ) :ref:`🔗` 为 :ref:`RID` 为 ``voxel_gi`` 的对象设置 :ref:`VoxelGIData.use_two_bounces` 值。 .. |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 (无返回值。)`