mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
6272 lines
830 KiB
ReStructuredText
6272 lines
830 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
||
.. DO NOT EDIT THIS FILE, but the RenderingServer.xml source instead.
|
||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||
|
||
.. _class_RenderingServer:
|
||
|
||
RenderingServer
|
||
===============
|
||
|
||
**Inherits:** :ref:`Object<class_Object>`
|
||
|
||
Server for anything visible.
|
||
|
||
Description
|
||
-----------
|
||
|
||
Server for anything visible. The rendering server is the API backend for everything visible. The whole scene system mounts on it to display.
|
||
|
||
The rendering server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
|
||
|
||
The rendering server can be used to bypass the scene system entirely.
|
||
|
||
Resources are created using the ``*_create`` functions.
|
||
|
||
All objects are drawn to a viewport. You can use the :ref:`Viewport<class_Viewport>` attached to the :ref:`SceneTree<class_SceneTree>` or you can create one yourself with :ref:`viewport_create<class_RenderingServer_method_viewport_create>`. When using a custom scenario or canvas, the scenario or canvas needs to be attached to the viewport using :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>` or :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>`.
|
||
|
||
In 3D, all visual objects must be associated with a scenario. The scenario is a visual representation of the world. If accessing the rendering server from a running game, the scenario can be accessed from the scene tree from any :ref:`Node3D<class_Node3D>` node with :ref:`Node3D.get_world_3d<class_Node3D_method_get_world_3d>`. Otherwise, a scenario can be created with :ref:`scenario_create<class_RenderingServer_method_scenario_create>`.
|
||
|
||
Similarly, in 2D, a canvas is needed to draw all canvas items.
|
||
|
||
In 3D, all visible objects are comprised of a resource and an instance. A resource can be a mesh, a particle system, a light, or any other 3D object. In order to be visible resources must be attached to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>`. The instance must also be attached to the scenario using :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>` in order to be visible.
|
||
|
||
In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas.
|
||
|
||
Tutorials
|
||
---------
|
||
|
||
- :doc:`Optimization using Servers <../tutorials/performance/using_servers>`
|
||
|
||
Properties
|
||
----------
|
||
|
||
+-------------------------+--------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`render_loop_enabled<class_RenderingServer_property_render_loop_enabled>` |
|
||
+-------------------------+--------------------------------------------------------------------------------+
|
||
|
||
Methods
|
||
-------
|
||
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image[]<class_Image>` | :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>` **(** :ref:`RID<class_RID>` base, :ref:`Array<class_Array>` material_overrides, :ref:`Vector2i<class_Vector2i>` image_size **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`camera_create<class_RenderingServer_method_camera_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`camera_effects_create<class_RenderingServer_method_camera_effects_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_effects_set_custom_exposure<class_RenderingServer_method_camera_effects_set_custom_exposure>` **(** :ref:`RID<class_RID>` camera_effects, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` exposure **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_effects_set_dof_blur<class_RenderingServer_method_camera_effects_set_dof_blur>` **(** :ref:`RID<class_RID>` camera_effects, :ref:`bool<class_bool>` far_enable, :ref:`float<class_float>` far_distance, :ref:`float<class_float>` far_transition, :ref:`bool<class_bool>` near_enable, :ref:`float<class_float>` near_distance, :ref:`float<class_float>` near_transition, :ref:`float<class_float>` amount **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_effects_set_dof_blur_bokeh_shape<class_RenderingServer_method_camera_effects_set_dof_blur_bokeh_shape>` **(** :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` shape **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_effects_set_dof_blur_quality<class_RenderingServer_method_camera_effects_set_dof_blur_quality>` **(** :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` quality, :ref:`bool<class_bool>` use_jitter **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_set_camera_effects<class_RenderingServer_method_camera_set_camera_effects>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` effects **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_set_cull_mask<class_RenderingServer_method_camera_set_cull_mask>` **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_set_environment<class_RenderingServer_method_camera_set_environment>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_set_frustum<class_RenderingServer_method_camera_set_frustum>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`Vector2<class_Vector2>` offset, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_set_orthogonal<class_RenderingServer_method_camera_set_orthogonal>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_set_perspective<class_RenderingServer_method_camera_set_perspective>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` fovy_degrees, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_set_transform<class_RenderingServer_method_camera_set_transform>` **(** :ref:`RID<class_RID>` camera, :ref:`Transform3D<class_Transform3D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`camera_set_use_vertical_aspect<class_RenderingServer_method_camera_set_use_vertical_aspect>` **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`canvas_create<class_RenderingServer_method_canvas_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_circle<class_RenderingServer_method_canvas_item_add_circle>` **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_clip_ignore<class_RenderingServer_method_canvas_item_add_clip_ignore>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_line<class_RenderingServer_method_canvas_item_add_line>` **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_mesh<class_RenderingServer_method_canvas_item_add_mesh>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_msdf_texture_rect_region<class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`int<class_int>` outline_size=0, :ref:`float<class_float>` px_range=1.0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_multimesh<class_RenderingServer_method_canvas_item_add_multimesh>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_nine_patch<class_RenderingServer_method_canvas_item_add_nine_patch>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` source, :ref:`RID<class_RID>` texture, :ref:`Vector2<class_Vector2>` topleft, :ref:`Vector2<class_Vector2>` bottomright, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` x_axis_mode=0, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1) **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_particles<class_RenderingServer_method_canvas_item_add_particles>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_polygon<class_RenderingServer_method_canvas_item_add_polygon>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_polyline<class_RenderingServer_method_canvas_item_add_polyline>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_primitive<class_RenderingServer_method_canvas_item_add_primitive>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs, :ref:`RID<class_RID>` texture, :ref:`float<class_float>` width=1.0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_rect<class_RenderingServer_method_canvas_item_add_rect>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_set_transform<class_RenderingServer_method_canvas_item_add_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_texture_rect<class_RenderingServer_method_canvas_item_add_texture_rect>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_texture_rect_region<class_RenderingServer_method_canvas_item_add_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false, :ref:`bool<class_bool>` clip_uv=true **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>` **(** :ref:`RID<class_RID>` item, :ref:`PackedInt32Array<class_PackedInt32Array>` indices, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`PackedInt32Array<class_PackedInt32Array>` bones=PackedInt32Array(), :ref:`PackedFloat32Array<class_PackedFloat32Array>` weights=PackedFloat32Array(), :ref:`RID<class_RID>` texture, :ref:`int<class_int>` count=-1 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_clear<class_RenderingServer_method_canvas_item_clear>` **(** :ref:`RID<class_RID>` item **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`canvas_item_create<class_RenderingServer_method_canvas_item_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_canvas_group_mode<class_RenderingServer_method_canvas_item_set_canvas_group_mode>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` mode, :ref:`float<class_float>` clear_margin=5.0, :ref:`bool<class_bool>` fit_empty=false, :ref:`float<class_float>` fit_margin=0.0, :ref:`bool<class_bool>` blur_mipmaps=false **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_clip<class_RenderingServer_method_canvas_item_set_clip>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_copy_to_backbuffer<class_RenderingServer_method_canvas_item_set_copy_to_backbuffer>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_custom_rect<class_RenderingServer_method_canvas_item_set_custom_rect>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_default_texture_filter<class_RenderingServer_method_canvas_item_set_default_texture_filter>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_default_texture_repeat<class_RenderingServer_method_canvas_item_set_default_texture_repeat>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_distance_field_mode<class_RenderingServer_method_canvas_item_set_distance_field_mode>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_draw_behind_parent<class_RenderingServer_method_canvas_item_set_draw_behind_parent>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_draw_index<class_RenderingServer_method_canvas_item_set_draw_index>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_light_mask<class_RenderingServer_method_canvas_item_set_light_mask>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_material<class_RenderingServer_method_canvas_item_set_material>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_modulate<class_RenderingServer_method_canvas_item_set_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_parent<class_RenderingServer_method_canvas_item_set_parent>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_self_modulate<class_RenderingServer_method_canvas_item_set_self_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_sort_children_by_y<class_RenderingServer_method_canvas_item_set_sort_children_by_y>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_transform<class_RenderingServer_method_canvas_item_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_use_parent_material<class_RenderingServer_method_canvas_item_set_use_parent_material>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_visibility_notifier<class_RenderingServer_method_canvas_item_set_visibility_notifier>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enable, :ref:`Rect2<class_Rect2>` area, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_visible<class_RenderingServer_method_canvas_item_set_visible>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_z_as_relative_to_parent<class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_item_set_z_index<class_RenderingServer_method_canvas_item_set_z_index>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_attach_to_canvas<class_RenderingServer_method_canvas_light_attach_to_canvas>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`canvas_light_create<class_RenderingServer_method_canvas_light_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_occluder_attach_to_canvas<class_RenderingServer_method_canvas_light_occluder_attach_to_canvas>` **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`canvas_light_occluder_create<class_RenderingServer_method_canvas_light_occluder_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_occluder_set_as_sdf_collision<class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision>` **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_occluder_set_enabled<class_RenderingServer_method_canvas_light_occluder_set_enabled>` **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_occluder_set_light_mask<class_RenderingServer_method_canvas_light_occluder_set_light_mask>` **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_occluder_set_polygon<class_RenderingServer_method_canvas_light_occluder_set_polygon>` **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_occluder_set_transform<class_RenderingServer_method_canvas_light_occluder_set_transform>` **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_color<class_RenderingServer_method_canvas_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_enabled<class_RenderingServer_method_canvas_light_set_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_energy<class_RenderingServer_method_canvas_light_set_energy>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_height<class_RenderingServer_method_canvas_light_set_height>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_item_cull_mask<class_RenderingServer_method_canvas_light_set_item_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_item_shadow_cull_mask<class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_layer_range<class_RenderingServer_method_canvas_light_set_layer_range>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_mode<class_RenderingServer_method_canvas_light_set_mode>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_shadow_color<class_RenderingServer_method_canvas_light_set_shadow_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_shadow_enabled<class_RenderingServer_method_canvas_light_set_shadow_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_shadow_filter<class_RenderingServer_method_canvas_light_set_shadow_filter>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` filter **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_shadow_smooth<class_RenderingServer_method_canvas_light_set_shadow_smooth>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_texture<class_RenderingServer_method_canvas_light_set_texture>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_texture_offset<class_RenderingServer_method_canvas_light_set_texture_offset>` **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_texture_scale<class_RenderingServer_method_canvas_light_set_texture_scale>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_transform<class_RenderingServer_method_canvas_light_set_transform>` **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_light_set_z_range<class_RenderingServer_method_canvas_light_set_z_range>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`canvas_occluder_polygon_create<class_RenderingServer_method_canvas_occluder_polygon_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_occluder_polygon_set_cull_mode<class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_occluder_polygon_set_shape<class_RenderingServer_method_canvas_occluder_polygon_set_shape>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PackedVector2Array<class_PackedVector2Array>` shape, :ref:`bool<class_bool>` closed **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_set_disable_scale<class_RenderingServer_method_canvas_set_disable_scale>` **(** :ref:`bool<class_bool>` disable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_set_item_mirroring<class_RenderingServer_method_canvas_set_item_mirroring>` **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_set_modulate<class_RenderingServer_method_canvas_set_modulate>` **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_set_shadow_texture_size<class_RenderingServer_method_canvas_set_shadow_texture_size>` **(** :ref:`int<class_int>` size **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`canvas_texture_create<class_RenderingServer_method_canvas_texture_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_texture_set_channel<class_RenderingServer_method_canvas_texture_set_channel>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` channel, :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_texture_set_shading_parameters<class_RenderingServer_method_canvas_texture_set_shading_parameters>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`Color<class_Color>` base_color, :ref:`float<class_float>` shininess **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_texture_set_texture_filter<class_RenderingServer_method_canvas_texture_set_texture_filter>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`canvas_texture_set_texture_repeat<class_RenderingServer_method_canvas_texture_set_texture_repeat>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>` **(** **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`decal_create<class_RenderingServer_method_decal_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_albedo_mix<class_RenderingServer_method_decal_set_albedo_mix>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_cull_mask<class_RenderingServer_method_decal_set_cull_mask>` **(** :ref:`RID<class_RID>` decal, :ref:`int<class_int>` mask **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_distance_fade<class_RenderingServer_method_decal_set_distance_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` length **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_emission_energy<class_RenderingServer_method_decal_set_emission_energy>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` energy **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_extents<class_RenderingServer_method_decal_set_extents>` **(** :ref:`RID<class_RID>` decal, :ref:`Vector3<class_Vector3>` extents **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_fade<class_RenderingServer_method_decal_set_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` above, :ref:`float<class_float>` below **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_modulate<class_RenderingServer_method_decal_set_modulate>` **(** :ref:`RID<class_RID>` decal, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_normal_fade<class_RenderingServer_method_decal_set_normal_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` fade **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decal_set_texture<class_RenderingServer_method_decal_set_texture>` **(** :ref:`RID<class_RID>` decal, :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` type, :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`decals_set_filter<class_RenderingServer_method_decals_set_filter>` **(** :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` filter **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`directional_light_create<class_RenderingServer_method_directional_light_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`directional_shadow_atlas_set_size<class_RenderingServer_method_directional_shadow_atlas_set_size>` **(** :ref:`int<class_int>` size, :ref:`bool<class_bool>` is_16bits **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`directional_shadow_quality_set<class_RenderingServer_method_directional_shadow_quality_set>` **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image<class_Image>` | :ref:`environment_bake_panorama<class_RenderingServer_method_environment_bake_panorama>` **(** :ref:`RID<class_RID>` environment, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`environment_create<class_RenderingServer_method_environment_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_glow_set_use_bicubic_upscale<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>` **(** :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_glow_set_use_high_quality<class_RenderingServer_method_environment_glow_set_use_high_quality>` **(** :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_adjustment<class_RenderingServer_method_environment_set_adjustment>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation, :ref:`bool<class_bool>` use_1d_color_correction, :ref:`RID<class_RID>` color_correction **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_ambient_light<class_RenderingServer_method_environment_set_ambient_light>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color, :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` ambient=0, :ref:`float<class_float>` energy=1.0, :ref:`float<class_float>` sky_contibution=0.0, :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` reflection_source=0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_background<class_RenderingServer_method_environment_set_background>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` bg **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_bg_color<class_RenderingServer_method_environment_set_bg_color>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_bg_energy<class_RenderingServer_method_environment_set_bg_energy>` **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` energy **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_canvas_max_layer<class_RenderingServer_method_environment_set_canvas_max_layer>` **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_fog<class_RenderingServer_method_environment_set_fog>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`Color<class_Color>` light_color, :ref:`float<class_float>` light_energy, :ref:`float<class_float>` sun_scatter, :ref:`float<class_float>` density, :ref:`float<class_float>` height, :ref:`float<class_float>` height_density, :ref:`float<class_float>` aerial_perspective **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_glow<class_RenderingServer_method_environment_set_glow>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`PackedFloat32Array<class_PackedFloat32Array>` levels, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` mix, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`float<class_float>` hdr_luminance_cap, :ref:`float<class_float>` glow_map_strength, :ref:`RID<class_RID>` glow_map **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_sdfgi<class_RenderingServer_method_environment_set_sdfgi>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` cascades, :ref:`float<class_float>` min_cell_size, :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` y_scale, :ref:`bool<class_bool>` use_occlusion, :ref:`float<class_float>` bounce_feedback, :ref:`bool<class_bool>` read_sky, :ref:`float<class_float>` energy, :ref:`float<class_float>` normal_bias, :ref:`float<class_float>` probe_bias **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_sdfgi_frames_to_converge<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>` **(** :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` frames **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_sdfgi_frames_to_update_light<class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light>` **(** :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` frames **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_sdfgi_ray_count<class_RenderingServer_method_environment_set_sdfgi_ray_count>` **(** :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` ray_count **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_sky<class_RenderingServer_method_environment_set_sky>` **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_sky_custom_fov<class_RenderingServer_method_environment_set_sky_custom_fov>` **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_sky_orientation<class_RenderingServer_method_environment_set_sky_orientation>` **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_ssao<class_RenderingServer_method_environment_set_ssao>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` radius, :ref:`float<class_float>` intensity, :ref:`float<class_float>` power, :ref:`float<class_float>` detail, :ref:`float<class_float>` horizon, :ref:`float<class_float>` sharpness, :ref:`float<class_float>` light_affect, :ref:`float<class_float>` ao_channel_affect **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_ssao_quality<class_RenderingServer_method_environment_set_ssao_quality>` **(** :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_ssil_quality<class_RenderingServer_method_environment_set_ssil_quality>` **(** :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_ssr<class_RenderingServer_method_environment_set_ssr>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` max_steps, :ref:`float<class_float>` fade_in, :ref:`float<class_float>` fade_out, :ref:`float<class_float>` depth_tolerance **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_ssr_roughness_quality<class_RenderingServer_method_environment_set_ssr_roughness_quality>` **(** :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` quality **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_tonemap<class_RenderingServer_method_environment_set_tonemap>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` tone_mapper, :ref:`float<class_float>` exposure, :ref:`float<class_float>` white, :ref:`bool<class_bool>` auto_exposure, :ref:`float<class_float>` min_luminance, :ref:`float<class_float>` max_luminance, :ref:`float<class_float>` auto_exp_speed, :ref:`float<class_float>` auto_exp_grey **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_volumetric_fog<class_RenderingServer_method_environment_set_volumetric_fog>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` density, :ref:`Color<class_Color>` albedo, :ref:`Color<class_Color>` emission, :ref:`float<class_float>` emission_energy, :ref:`float<class_float>` anisotropy, :ref:`float<class_float>` length, :ref:`float<class_float>` p_detail_spread, :ref:`float<class_float>` gi_inject, :ref:`bool<class_bool>` temporal_reprojection, :ref:`float<class_float>` temporal_reprojection_amount, :ref:`float<class_float>` ambient_inject **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_volumetric_fog_filter_active<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>` **(** :ref:`bool<class_bool>` active **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`environment_set_volumetric_fog_volume_size<class_RenderingServer_method_environment_set_volumetric_fog_volume_size>` **(** :ref:`int<class_int>` size, :ref:`int<class_int>` depth **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`fog_volume_create<class_RenderingServer_method_fog_volume_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`fog_volume_set_extents<class_RenderingServer_method_fog_volume_set_extents>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`Vector3<class_Vector3>` extents **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`fog_volume_set_material<class_RenderingServer_method_fog_volume_set_material>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`RID<class_RID>` material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`fog_volume_set_shape<class_RenderingServer_method_fog_volume_set_shape>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` shape **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`force_draw<class_RenderingServer_method_force_draw>` **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`force_sync<class_RenderingServer_method_force_sync>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`free_rid<class_RenderingServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_frame_setup_time_cpu<class_RenderingServer_method_get_frame_setup_time_cpu>` **(** **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`get_rendering_device<class_RenderingServer_method_get_rendering_device>` **(** **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>` **(** :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` info **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`get_video_adapter_name<class_RenderingServer_method_get_video_adapter_name>` **(** **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`DeviceType<enum_RenderingDevice_DeviceType>` | :ref:`get_video_adapter_type<class_RenderingServer_method_get_video_adapter_type>` **(** **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`get_video_adapter_vendor<class_RenderingServer_method_get_video_adapter_vendor>` **(** **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`gi_set_use_half_resolution<class_RenderingServer_method_gi_set_use_half_resolution>` **(** :ref:`bool<class_bool>` half_resolution **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`global_variable_add<class_RenderingServer_method_global_variable_add>` **(** :ref:`StringName<class_StringName>` name, :ref:`GlobalVariableType<enum_RenderingServer_GlobalVariableType>` type, :ref:`Variant<class_Variant>` default_value **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Variant<class_Variant>` | :ref:`global_variable_get<class_RenderingServer_method_global_variable_get>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`global_variable_get_list<class_RenderingServer_method_global_variable_get_list>` **(** **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`GlobalVariableType<enum_RenderingServer_GlobalVariableType>` | :ref:`global_variable_get_type<class_RenderingServer_method_global_variable_get_type>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`global_variable_remove<class_RenderingServer_method_global_variable_remove>` **(** :ref:`StringName<class_StringName>` name **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`global_variable_set<class_RenderingServer_method_global_variable_set>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`global_variable_set_override<class_RenderingServer_method_global_variable_set_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`has_changed<class_RenderingServer_method_has_changed>` **(** **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`has_feature<class_RenderingServer_method_has_feature>` **(** :ref:`Features<enum_RenderingServer_Features>` feature **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`has_os_feature<class_RenderingServer_method_has_os_feature>` **(** :ref:`String<class_String>` feature **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_attach_object_instance_id<class_RenderingServer_method_instance_attach_object_instance_id>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_attach_skeleton<class_RenderingServer_method_instance_attach_skeleton>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`instance_create<class_RenderingServer_method_instance_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`instance_create2<class_RenderingServer_method_instance_create2>` **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter<class_RenderingServer_method_instance_geometry_get_shader_parameter>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter_default_value<class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>` | :ref:`instance_geometry_get_shader_parameter_list<class_RenderingServer_method_instance_geometry_get_shader_parameter_list>` **(** :ref:`RID<class_RID>` instance **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_cast_shadows_setting<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>` **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` shadow_casting_setting **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_flag<class_RenderingServer_method_instance_geometry_set_flag>` **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_lightmap<class_RenderingServer_method_instance_geometry_set_lightmap>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` lightmap, :ref:`Rect2<class_Rect2>` lightmap_uv_scale, :ref:`int<class_int>` lightmap_slice **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_lod_bias<class_RenderingServer_method_instance_geometry_set_lod_bias>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` lod_bias **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_material_overlay<class_RenderingServer_method_instance_geometry_set_material_overlay>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_material_override<class_RenderingServer_method_instance_geometry_set_material_override>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_shader_parameter<class_RenderingServer_method_instance_geometry_set_shader_parameter>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_transparency<class_RenderingServer_method_instance_geometry_set_transparency>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` transparency **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_geometry_set_visibility_range<class_RenderingServer_method_instance_geometry_set_visibility_range>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` min_margin, :ref:`float<class_float>` max_margin, :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` fade_mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_blend_shape_weight<class_RenderingServer_method_instance_set_blend_shape_weight>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_custom_aabb<class_RenderingServer_method_instance_set_custom_aabb>` **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_extra_visibility_margin<class_RenderingServer_method_instance_set_extra_visibility_margin>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_layer_mask<class_RenderingServer_method_instance_set_layer_mask>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_surface_override_material<class_RenderingServer_method_instance_set_surface_override_material>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_transform<class_RenderingServer_method_instance_set_transform>` **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_visibility_parent<class_RenderingServer_method_instance_set_visibility_parent>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` parent **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`instance_set_visible<class_RenderingServer_method_instance_set_visible>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>` | :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>` **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>` | :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>` **(** :ref:`Array<class_Array>` convex, :ref:`RID<class_RID>` scenario **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>` | :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_directional_set_blend_splits<class_RenderingServer_method_light_directional_set_blend_splits>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_directional_set_shadow_mode<class_RenderingServer_method_light_directional_set_shadow_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_directional_set_sky_only<class_RenderingServer_method_light_directional_set_sky_only>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_omni_set_shadow_mode<class_RenderingServer_method_light_omni_set_shadow_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_projectors_set_filter<class_RenderingServer_method_light_projectors_set_filter>` **(** :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` filter **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_bake_mode<class_RenderingServer_method_light_set_bake_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` bake_mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_color<class_RenderingServer_method_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_cull_mask<class_RenderingServer_method_light_set_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_max_sdfgi_cascade<class_RenderingServer_method_light_set_max_sdfgi_cascade>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` cascade **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_negative<class_RenderingServer_method_light_set_negative>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_param<class_RenderingServer_method_light_set_param>` **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_RenderingServer_LightParam>` param, :ref:`float<class_float>` value **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_projector<class_RenderingServer_method_light_set_projector>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_reverse_cull_face_mode<class_RenderingServer_method_light_set_reverse_cull_face_mode>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_shadow<class_RenderingServer_method_light_set_shadow>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`light_set_shadow_color<class_RenderingServer_method_light_set_shadow_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`lightmap_create<class_RenderingServer_method_lightmap_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_bsp_tree<class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`lightmap_get_probe_capture_points<class_RenderingServer_method_lightmap_get_probe_capture_points>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`lightmap_get_probe_capture_sh<class_RenderingServer_method_lightmap_get_probe_capture_sh>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_tetrahedra<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`lightmap_set_probe_bounds<class_RenderingServer_method_lightmap_set_probe_bounds>` **(** :ref:`RID<class_RID>` lightmap, :ref:`AABB<class_AABB>` bounds **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`lightmap_set_probe_capture_data<class_RenderingServer_method_lightmap_set_probe_capture_data>` **(** :ref:`RID<class_RID>` lightmap, :ref:`PackedVector3Array<class_PackedVector3Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` point_sh, :ref:`PackedInt32Array<class_PackedInt32Array>` tetrahedra, :ref:`PackedInt32Array<class_PackedInt32Array>` bsp_tree **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`lightmap_set_probe_capture_update_speed<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>` **(** :ref:`float<class_float>` speed **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`lightmap_set_probe_interior<class_RenderingServer_method_lightmap_set_probe_interior>` **(** :ref:`RID<class_RID>` lightmap, :ref:`bool<class_bool>` interior **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`lightmap_set_textures<class_RenderingServer_method_lightmap_set_textures>` **(** :ref:`RID<class_RID>` lightmap, :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` uses_sh **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`make_sphere_mesh<class_RenderingServer_method_make_sphere_mesh>` **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`material_create<class_RenderingServer_method_material_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Variant<class_Variant>` | :ref:`material_get_param<class_RenderingServer_method_material_get_param>` **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`material_set_next_pass<class_RenderingServer_method_material_set_next_pass>` **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`material_set_param<class_RenderingServer_method_material_set_param>` **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`material_set_render_priority<class_RenderingServer_method_material_set_render_priority>` **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`material_set_shader<class_RenderingServer_method_material_set_shader>` **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_add_surface<class_RenderingServer_method_mesh_add_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`Dictionary<class_Dictionary>` surface **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_add_surface_from_arrays<class_RenderingServer_method_mesh_add_surface_from_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[], :ref:`Dictionary<class_Dictionary>` lods={}, :ref:`int<class_int>` compress_format=0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_clear<class_RenderingServer_method_mesh_clear>` **(** :ref:`RID<class_RID>` mesh **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`mesh_create<class_RenderingServer_method_mesh_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`mesh_create_from_surfaces<class_RenderingServer_method_mesh_create_from_surfaces>` **(** :ref:`Dictionary[]<class_Dictionary>` surfaces, :ref:`int<class_int>` blend_shape_count=0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_RenderingServer_method_mesh_get_blend_shape_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` | :ref:`mesh_get_blend_shape_mode<class_RenderingServer_method_mesh_get_blend_shape_mode>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`AABB<class_AABB>` | :ref:`mesh_get_custom_aabb<class_RenderingServer_method_mesh_get_custom_aabb>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Dictionary<class_Dictionary>` | :ref:`mesh_get_surface<class_RenderingServer_method_mesh_get_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_RenderingServer_method_mesh_get_surface_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_set_blend_shape_mode<class_RenderingServer_method_mesh_set_blend_shape_mode>` **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_set_custom_aabb<class_RenderingServer_method_mesh_set_custom_aabb>` **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_set_shadow_mesh<class_RenderingServer_method_mesh_set_shadow_mesh>` **(** :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` shadow_mesh **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>` | :ref:`mesh_surface_get_arrays<class_RenderingServer_method_mesh_surface_get_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>` | :ref:`mesh_surface_get_blend_shape_arrays<class_RenderingServer_method_mesh_surface_get_blend_shape_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`mesh_surface_get_format_attribute_stride<class_RenderingServer_method_mesh_surface_get_format_attribute_stride>` **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_count **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`mesh_surface_get_format_offset<class_RenderingServer_method_mesh_surface_get_format_offset>` **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_count, :ref:`int<class_int>` array_index **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`mesh_surface_get_format_skin_stride<class_RenderingServer_method_mesh_surface_get_format_skin_stride>` **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_count **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`mesh_surface_get_format_vertex_stride<class_RenderingServer_method_mesh_surface_get_format_vertex_stride>` **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_count **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`mesh_surface_get_material<class_RenderingServer_method_mesh_surface_get_material>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_surface_set_material<class_RenderingServer_method_mesh_surface_set_material>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_surface_update_attribute_region<class_RenderingServer_method_mesh_surface_update_attribute_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_surface_update_skin_region<class_RenderingServer_method_mesh_surface_update_skin_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`mesh_surface_update_vertex_region<class_RenderingServer_method_mesh_surface_update_vertex_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`multimesh_allocate_data<class_RenderingServer_method_multimesh_allocate_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` instances, :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` transform_format, :ref:`bool<class_bool>` color_format=false, :ref:`bool<class_bool>` custom_data_format=false **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`multimesh_create<class_RenderingServer_method_multimesh_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`AABB<class_AABB>` | :ref:`multimesh_get_aabb<class_RenderingServer_method_multimesh_get_aabb>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`multimesh_get_instance_count<class_RenderingServer_method_multimesh_get_instance_count>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`multimesh_get_mesh<class_RenderingServer_method_multimesh_get_mesh>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`multimesh_get_visible_instances<class_RenderingServer_method_multimesh_get_visible_instances>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_color<class_RenderingServer_method_multimesh_instance_get_color>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_custom_data<class_RenderingServer_method_multimesh_instance_get_custom_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Transform3D<class_Transform3D>` | :ref:`multimesh_instance_get_transform<class_RenderingServer_method_multimesh_instance_get_transform>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Transform2D<class_Transform2D>` | :ref:`multimesh_instance_get_transform_2d<class_RenderingServer_method_multimesh_instance_get_transform_2d>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`multimesh_instance_set_color<class_RenderingServer_method_multimesh_instance_set_color>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`multimesh_instance_set_custom_data<class_RenderingServer_method_multimesh_instance_set_custom_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`multimesh_instance_set_transform<class_RenderingServer_method_multimesh_instance_set_transform>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform3D<class_Transform3D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`multimesh_instance_set_transform_2d<class_RenderingServer_method_multimesh_instance_set_transform_2d>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` **(** :ref:`RID<class_RID>` multimesh, :ref:`PackedFloat32Array<class_PackedFloat32Array>` buffer **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`multimesh_set_mesh<class_RenderingServer_method_multimesh_set_mesh>` **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`multimesh_set_visible_instances<class_RenderingServer_method_multimesh_set_visible_instances>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`occluder_create<class_RenderingServer_method_occluder_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`occluder_set_mesh<class_RenderingServer_method_occluder_set_mesh>` **(** :ref:`RID<class_RID>` occluder, :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`omni_light_create<class_RenderingServer_method_omni_light_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`particles_collision_create<class_RenderingServer_method_particles_collision_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_height_field_update<class_RenderingServer_method_particles_collision_height_field_update>` **(** :ref:`RID<class_RID>` particles_collision **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_attractor_attenuation<class_RenderingServer_method_particles_collision_set_attractor_attenuation>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` curve **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_attractor_directionality<class_RenderingServer_method_particles_collision_set_attractor_directionality>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` amount **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_attractor_strength<class_RenderingServer_method_particles_collision_set_attractor_strength>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` setrngth **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_box_extents<class_RenderingServer_method_particles_collision_set_box_extents>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`Vector3<class_Vector3>` extents **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_collision_type<class_RenderingServer_method_particles_collision_set_collision_type>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` type **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_cull_mask<class_RenderingServer_method_particles_collision_set_cull_mask>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`int<class_int>` mask **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_field_texture<class_RenderingServer_method_particles_collision_set_field_texture>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`RID<class_RID>` texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_height_field_resolution<class_RenderingServer_method_particles_collision_set_height_field_resolution>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` resolution **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_collision_set_sphere_radius<class_RenderingServer_method_particles_collision_set_sphere_radius>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` radius **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`particles_create<class_RenderingServer_method_particles_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_emit<class_RenderingServer_method_particles_emit>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` emit_flags **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`AABB<class_AABB>` | :ref:`particles_get_current_aabb<class_RenderingServer_method_particles_get_current_aabb>` **(** :ref:`RID<class_RID>` particles **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_RenderingServer_method_particles_get_emitting>` **(** :ref:`RID<class_RID>` particles **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_RenderingServer_method_particles_is_inactive>` **(** :ref:`RID<class_RID>` particles **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_request_process<class_RenderingServer_method_particles_request_process>` **(** :ref:`RID<class_RID>` particles **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_restart<class_RenderingServer_method_particles_restart>` **(** :ref:`RID<class_RID>` particles **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_amount<class_RenderingServer_method_particles_set_amount>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_collision_base_size<class_RenderingServer_method_particles_set_collision_base_size>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` size **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_custom_aabb<class_RenderingServer_method_particles_set_custom_aabb>` **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_draw_order<class_RenderingServer_method_particles_set_draw_order>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` order **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_draw_pass_mesh<class_RenderingServer_method_particles_set_draw_pass_mesh>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_draw_passes<class_RenderingServer_method_particles_set_draw_passes>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_emission_transform<class_RenderingServer_method_particles_set_emission_transform>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_emitting<class_RenderingServer_method_particles_set_emitting>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_explosiveness_ratio<class_RenderingServer_method_particles_set_explosiveness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_fixed_fps<class_RenderingServer_method_particles_set_fixed_fps>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_fractional_delta<class_RenderingServer_method_particles_set_fractional_delta>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_interpolate<class_RenderingServer_method_particles_set_interpolate>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_lifetime<class_RenderingServer_method_particles_set_lifetime>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_mode<class_RenderingServer_method_particles_set_mode>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_one_shot<class_RenderingServer_method_particles_set_one_shot>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_pre_process_time<class_RenderingServer_method_particles_set_pre_process_time>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_process_material<class_RenderingServer_method_particles_set_process_material>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_randomness_ratio<class_RenderingServer_method_particles_set_randomness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_speed_scale<class_RenderingServer_method_particles_set_speed_scale>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_subemitter<class_RenderingServer_method_particles_set_subemitter>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` subemitter_particles **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_trail_bind_poses<class_RenderingServer_method_particles_set_trail_bind_poses>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D[]<class_Transform3D>` bind_poses **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_trails<class_RenderingServer_method_particles_set_trails>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` length_sec **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_transform_align<class_RenderingServer_method_particles_set_transform_align>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` align **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`particles_set_use_local_coordinates<class_RenderingServer_method_particles_set_use_local_coordinates>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`reflection_probe_create<class_RenderingServer_method_reflection_probe_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_ambient_color<class_RenderingServer_method_reflection_probe_set_ambient_color>` **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_ambient_energy<class_RenderingServer_method_reflection_probe_set_ambient_energy>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_ambient_mode<class_RenderingServer_method_reflection_probe_set_ambient_mode>` **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_as_interior<class_RenderingServer_method_reflection_probe_set_as_interior>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_cull_mask<class_RenderingServer_method_reflection_probe_set_cull_mask>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_enable_box_projection<class_RenderingServer_method_reflection_probe_set_enable_box_projection>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_enable_shadows<class_RenderingServer_method_reflection_probe_set_enable_shadows>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_extents<class_RenderingServer_method_reflection_probe_set_extents>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` extents **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_intensity<class_RenderingServer_method_reflection_probe_set_intensity>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_max_distance<class_RenderingServer_method_reflection_probe_set_max_distance>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_mesh_lod_threshold<class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` pixels **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_origin_offset<class_RenderingServer_method_reflection_probe_set_origin_offset>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_resolution<class_RenderingServer_method_reflection_probe_set_resolution>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` resolution **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`reflection_probe_set_update_mode<class_RenderingServer_method_reflection_probe_set_update_mode>` **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`request_frame_drawn_callback<class_RenderingServer_method_request_frame_drawn_callback>` **(** :ref:`Callable<class_Callable>` callable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`scenario_create<class_RenderingServer_method_scenario_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`scenario_set_camera_effects<class_RenderingServer_method_scenario_set_camera_effects>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` effects **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`scenario_set_environment<class_RenderingServer_method_scenario_set_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`scenario_set_fallback_environment<class_RenderingServer_method_scenario_set_fallback_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`screen_space_roughness_limiter_set_active<class_RenderingServer_method_screen_space_roughness_limiter_set_active>` **(** :ref:`bool<class_bool>` enable, :ref:`float<class_float>` amount, :ref:`float<class_float>` limit **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`set_boot_image<class_RenderingServer_method_set_boot_image>` **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`set_debug_generate_wireframes<class_RenderingServer_method_set_debug_generate_wireframes>` **(** :ref:`bool<class_bool>` generate **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`set_default_clear_color<class_RenderingServer_method_set_default_clear_color>` **(** :ref:`Color<class_Color>` color **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`shader_create<class_RenderingServer_method_shader_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`shader_get_code<class_RenderingServer_method_shader_get_code>` **(** :ref:`RID<class_RID>` shader **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`shader_get_default_texture_param<class_RenderingServer_method_shader_get_default_texture_param>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` param, :ref:`int<class_int>` index=0 **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Variant<class_Variant>` | :ref:`shader_get_param_default<class_RenderingServer_method_shader_get_param_default>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` param **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Dictionary[]<class_Dictionary>` | :ref:`shader_get_param_list<class_RenderingServer_method_shader_get_param_list>` **(** :ref:`RID<class_RID>` shader **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`shader_set_default_texture_param<class_RenderingServer_method_shader_set_default_texture_param>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` param, :ref:`RID<class_RID>` texture, :ref:`int<class_int>` index=0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`shadows_quality_set<class_RenderingServer_method_shadows_quality_set>` **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`skeleton_allocate_data<class_RenderingServer_method_skeleton_allocate_data>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Transform3D<class_Transform3D>` | :ref:`skeleton_bone_get_transform<class_RenderingServer_method_skeleton_bone_get_transform>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Transform2D<class_Transform2D>` | :ref:`skeleton_bone_get_transform_2d<class_RenderingServer_method_skeleton_bone_get_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`skeleton_bone_set_transform<class_RenderingServer_method_skeleton_bone_set_transform>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`skeleton_bone_set_transform_2d<class_RenderingServer_method_skeleton_bone_set_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`skeleton_create<class_RenderingServer_method_skeleton_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`skeleton_get_bone_count<class_RenderingServer_method_skeleton_get_bone_count>` **(** :ref:`RID<class_RID>` skeleton **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`skeleton_set_base_transform_2d<class_RenderingServer_method_skeleton_set_base_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`Transform2D<class_Transform2D>` base_transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image<class_Image>` | :ref:`sky_bake_panorama<class_RenderingServer_method_sky_bake_panorama>` **(** :ref:`RID<class_RID>` sky, :ref:`float<class_float>` energy, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`sky_create<class_RenderingServer_method_sky_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`sky_set_material<class_RenderingServer_method_sky_set_material>` **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` material **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`sky_set_mode<class_RenderingServer_method_sky_set_mode>` **(** :ref:`RID<class_RID>` sky, :ref:`SkyMode<enum_RenderingServer_SkyMode>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`sky_set_radiance_size<class_RenderingServer_method_sky_set_radiance_size>` **(** :ref:`RID<class_RID>` sky, :ref:`int<class_int>` radiance_size **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`spot_light_create<class_RenderingServer_method_spot_light_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`sub_surface_scattering_set_quality<class_RenderingServer_method_sub_surface_scattering_set_quality>` **(** :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` quality **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`sub_surface_scattering_set_scale<class_RenderingServer_method_sub_surface_scattering_set_scale>` **(** :ref:`float<class_float>` scale, :ref:`float<class_float>` depth_scale **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`texture_2d_create<class_RenderingServer_method_texture_2d_create>` **(** :ref:`Image<class_Image>` image **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image<class_Image>` | :ref:`texture_2d_get<class_RenderingServer_method_texture_2d_get>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image<class_Image>` | :ref:`texture_2d_layer_get<class_RenderingServer_method_texture_2d_layer_get>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`texture_2d_layered_create<class_RenderingServer_method_texture_2d_layered_create>` **(** :ref:`Image[]<class_Image>` layers, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`texture_2d_layered_placeholder_create<class_RenderingServer_method_texture_2d_layered_placeholder_create>` **(** :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`texture_2d_placeholder_create<class_RenderingServer_method_texture_2d_placeholder_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`texture_2d_update<class_RenderingServer_method_texture_2d_update>` **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`texture_3d_create<class_RenderingServer_method_texture_3d_create>` **(** :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`bool<class_bool>` mipmaps, :ref:`Image[]<class_Image>` data **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Image[]<class_Image>` | :ref:`texture_3d_get<class_RenderingServer_method_texture_3d_get>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`texture_3d_placeholder_create<class_RenderingServer_method_texture_3d_placeholder_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`texture_3d_update<class_RenderingServer_method_texture_3d_update>` **(** :ref:`RID<class_RID>` texture, :ref:`Image[]<class_Image>` data **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`String<class_String>` | :ref:`texture_get_path<class_RenderingServer_method_texture_get_path>` **(** :ref:`RID<class_RID>` texture **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`texture_proxy_create<class_RenderingServer_method_texture_proxy_create>` **(** :ref:`RID<class_RID>` base **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`texture_proxy_update<class_RenderingServer_method_texture_proxy_update>` **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` proxy_to **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`texture_replace<class_RenderingServer_method_texture_replace>` **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` by_texture **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`texture_set_force_redraw_if_visible<class_RenderingServer_method_texture_set_force_redraw_if_visible>` **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`texture_set_path<class_RenderingServer_method_texture_set_path>` **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`texture_set_size_override<class_RenderingServer_method_texture_set_size_override>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_attach_camera<class_RenderingServer_method_viewport_attach_camera>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_attach_to_screen<class_RenderingServer_method_viewport_attach_to_screen>` **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0), :ref:`int<class_int>` screen=0 **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`viewport_create<class_RenderingServer_method_viewport_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_cpu<class_RenderingServer_method_viewport_get_measured_render_time_cpu>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`viewport_get_render_info<class_RenderingServer_method_viewport_get_render_info>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` type, :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` info **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`viewport_get_texture<class_RenderingServer_method_viewport_get_texture>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_remove_canvas<class_RenderingServer_method_viewport_remove_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_active<class_RenderingServer_method_viewport_set_active>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_canvas_stacking<class_RenderingServer_method_viewport_set_canvas_stacking>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` layer, :ref:`int<class_int>` sublayer **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_canvas_transform<class_RenderingServer_method_viewport_set_canvas_transform>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_clear_mode<class_RenderingServer_method_viewport_set_clear_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` clear_mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_debug_draw<class_RenderingServer_method_viewport_set_debug_draw>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` draw **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_default_canvas_item_texture_filter<class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter>` **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_default_canvas_item_texture_repeat<class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat>` **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_disable_2d<class_RenderingServer_method_viewport_set_disable_2d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_disable_3d<class_RenderingServer_method_viewport_set_disable_3d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_disable_environment<class_RenderingServer_method_viewport_set_disable_environment>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_fsr_mipmap_bias<class_RenderingServer_method_viewport_set_fsr_mipmap_bias>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` mipmap_bias **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_fsr_sharpness<class_RenderingServer_method_viewport_set_fsr_sharpness>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` sharpness **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_global_canvas_transform<class_RenderingServer_method_viewport_set_global_canvas_transform>` **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_measure_render_time<class_RenderingServer_method_viewport_set_measure_render_time>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_msaa<class_RenderingServer_method_viewport_set_msaa>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_occlusion_culling_build_quality<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>` **(** :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` quality **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_occlusion_rays_per_thread<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>` **(** :ref:`int<class_int>` rays_per_thread **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_parent_viewport<class_RenderingServer_method_viewport_set_parent_viewport>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_scaling_3d_mode<class_RenderingServer_method_viewport_set_scaling_3d_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` scaling_3d_mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_scaling_3d_scale<class_RenderingServer_method_viewport_set_scaling_3d_scale>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` scale **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_screen_space_aa<class_RenderingServer_method_viewport_set_screen_space_aa>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_sdf_oversize_and_scale<class_RenderingServer_method_viewport_set_sdf_oversize_and_scale>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` oversize, :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` scale **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision<class_RenderingServer_method_viewport_set_shadow_atlas_quadrant_subdivision>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_shadow_atlas_size<class_RenderingServer_method_viewport_set_shadow_atlas_size>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` size, :ref:`bool<class_bool>` use_16_bits=false **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_size<class_RenderingServer_method_viewport_set_size>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_snap_2d_transforms_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_snap_2d_vertices_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_transparent_background<class_RenderingServer_method_viewport_set_transparent_background>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_update_mode<class_RenderingServer_method_viewport_set_update_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` update_mode **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_use_debanding<class_RenderingServer_method_viewport_set_use_debanding>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_use_occlusion_culling<class_RenderingServer_method_viewport_set_use_occlusion_culling>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`viewport_set_use_xr<class_RenderingServer_method_viewport_set_use_xr>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_xr **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`visibility_notifier_create<class_RenderingServer_method_visibility_notifier_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`visibility_notifier_set_aabb<class_RenderingServer_method_visibility_notifier_set_aabb>` **(** :ref:`RID<class_RID>` notifier, :ref:`AABB<class_AABB>` aabb **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`visibility_notifier_set_callbacks<class_RenderingServer_method_visibility_notifier_set_callbacks>` **(** :ref:`RID<class_RID>` notifier, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_allocate_data<class_RenderingServer_method_voxel_gi_allocate_data>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`Transform3D<class_Transform3D>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3i<class_Vector3i>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`voxel_gi_create<class_RenderingServer_method_voxel_gi_create>` **(** **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_data_cells<class_RenderingServer_method_voxel_gi_get_data_cells>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_distance_field<class_RenderingServer_method_voxel_gi_get_distance_field>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`voxel_gi_get_level_counts<class_RenderingServer_method_voxel_gi_get_level_counts>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_octree_cells<class_RenderingServer_method_voxel_gi_get_octree_cells>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector3i<class_Vector3i>` | :ref:`voxel_gi_get_octree_size<class_RenderingServer_method_voxel_gi_get_octree_size>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Transform3D<class_Transform3D>` | :ref:`voxel_gi_get_to_cell_xform<class_RenderingServer_method_voxel_gi_get_to_cell_xform>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_set_bias<class_RenderingServer_method_voxel_gi_set_bias>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_set_dynamic_range<class_RenderingServer_method_voxel_gi_set_dynamic_range>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` range **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_set_energy<class_RenderingServer_method_voxel_gi_set_energy>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` energy **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_set_interior<class_RenderingServer_method_voxel_gi_set_interior>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_set_normal_bias<class_RenderingServer_method_voxel_gi_set_normal_bias>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_set_propagation<class_RenderingServer_method_voxel_gi_set_propagation>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` amount **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_set_quality<class_RenderingServer_method_voxel_gi_set_quality>` **(** :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` quality **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| void | :ref:`voxel_gi_set_use_two_bounces<class_RenderingServer_method_voxel_gi_set_use_two_bounces>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)** |
|
||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
Signals
|
||
-------
|
||
|
||
.. _class_RenderingServer_signal_frame_post_draw:
|
||
|
||
- **frame_post_draw** **(** **)**
|
||
|
||
Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_signal_frame_pre_draw:
|
||
|
||
- **frame_pre_draw** **(** **)**
|
||
|
||
Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
|
||
|
||
Enumerations
|
||
------------
|
||
|
||
.. _enum_RenderingServer_TextureLayeredType:
|
||
|
||
.. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY:
|
||
|
||
.. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP:
|
||
|
||
.. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY:
|
||
|
||
enum **TextureLayeredType**:
|
||
|
||
- **TEXTURE_LAYERED_2D_ARRAY** = **0**
|
||
|
||
- **TEXTURE_LAYERED_CUBEMAP** = **1**
|
||
|
||
- **TEXTURE_LAYERED_CUBEMAP_ARRAY** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CubeMapLayer:
|
||
|
||
.. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT:
|
||
|
||
.. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT:
|
||
|
||
.. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM:
|
||
|
||
.. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP:
|
||
|
||
.. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT:
|
||
|
||
.. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK:
|
||
|
||
enum **CubeMapLayer**:
|
||
|
||
- **CUBEMAP_LAYER_LEFT** = **0**
|
||
|
||
- **CUBEMAP_LAYER_RIGHT** = **1**
|
||
|
||
- **CUBEMAP_LAYER_BOTTOM** = **2**
|
||
|
||
- **CUBEMAP_LAYER_TOP** = **3**
|
||
|
||
- **CUBEMAP_LAYER_FRONT** = **4**
|
||
|
||
- **CUBEMAP_LAYER_BACK** = **5**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ShaderMode:
|
||
|
||
.. _class_RenderingServer_constant_SHADER_SPATIAL:
|
||
|
||
.. _class_RenderingServer_constant_SHADER_CANVAS_ITEM:
|
||
|
||
.. _class_RenderingServer_constant_SHADER_PARTICLES:
|
||
|
||
.. _class_RenderingServer_constant_SHADER_SKY:
|
||
|
||
.. _class_RenderingServer_constant_SHADER_FOG:
|
||
|
||
.. _class_RenderingServer_constant_SHADER_MAX:
|
||
|
||
enum **ShaderMode**:
|
||
|
||
- **SHADER_SPATIAL** = **0** --- Shader is a 3D shader.
|
||
|
||
- **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader.
|
||
|
||
- **SHADER_PARTICLES** = **2** --- Shader is a particle shader.
|
||
|
||
- **SHADER_SKY** = **3** --- Shader is a sky shader.
|
||
|
||
- **SHADER_FOG** = **4** --- Shader is a fog shader.
|
||
|
||
- **SHADER_MAX** = **5** --- Represents the size of the :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ArrayType:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_VERTEX:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_NORMAL:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_TANGENT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_COLOR:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_TEX_UV:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_TEX_UV2:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM0:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM1:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM2:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM3:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_BONES:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_WEIGHTS:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_INDEX:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_MAX:
|
||
|
||
enum **ArrayType**:
|
||
|
||
- **ARRAY_VERTEX** = **0** --- Array is a vertex array.
|
||
|
||
- **ARRAY_NORMAL** = **1** --- Array is a normal array.
|
||
|
||
- **ARRAY_TANGENT** = **2** --- Array is a tangent array.
|
||
|
||
- **ARRAY_COLOR** = **3** --- Array is a color array.
|
||
|
||
- **ARRAY_TEX_UV** = **4** --- Array is an UV coordinates array.
|
||
|
||
- **ARRAY_TEX_UV2** = **5** --- Array is an UV coordinates array for the second UV coordinates.
|
||
|
||
- **ARRAY_CUSTOM0** = **6**
|
||
|
||
- **ARRAY_CUSTOM1** = **7**
|
||
|
||
- **ARRAY_CUSTOM2** = **8**
|
||
|
||
- **ARRAY_CUSTOM3** = **9**
|
||
|
||
- **ARRAY_BONES** = **10** --- Array contains bone information.
|
||
|
||
- **ARRAY_WEIGHTS** = **11** --- Array is weight information.
|
||
|
||
- **ARRAY_INDEX** = **12** --- Array is index array.
|
||
|
||
- **ARRAY_MAX** = **13** --- Represents the size of the :ref:`ArrayType<enum_RenderingServer_ArrayType>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ArrayCustomFormat:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX:
|
||
|
||
enum **ArrayCustomFormat**:
|
||
|
||
- **ARRAY_CUSTOM_RGBA8_UNORM** = **0**
|
||
|
||
- **ARRAY_CUSTOM_RGBA8_SNORM** = **1**
|
||
|
||
- **ARRAY_CUSTOM_RG_HALF** = **2**
|
||
|
||
- **ARRAY_CUSTOM_RGBA_HALF** = **3**
|
||
|
||
- **ARRAY_CUSTOM_R_FLOAT** = **4**
|
||
|
||
- **ARRAY_CUSTOM_RG_FLOAT** = **5**
|
||
|
||
- **ARRAY_CUSTOM_RGB_FLOAT** = **6**
|
||
|
||
- **ARRAY_CUSTOM_RGBA_FLOAT** = **7**
|
||
|
||
- **ARRAY_CUSTOM_MAX** = **8**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ArrayFormat:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_BONES:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS:
|
||
|
||
enum **ArrayFormat**:
|
||
|
||
- **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array.
|
||
|
||
- **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array.
|
||
|
||
- **ARRAY_FORMAT_TANGENT** = **4** --- Flag used to mark a tangent array.
|
||
|
||
- **ARRAY_FORMAT_COLOR** = **8** --- Flag used to mark a color array.
|
||
|
||
- **ARRAY_FORMAT_TEX_UV** = **16** --- Flag used to mark an UV coordinates array.
|
||
|
||
- **ARRAY_FORMAT_TEX_UV2** = **32** --- Flag used to mark an UV coordinates array for the second UV coordinates.
|
||
|
||
- **ARRAY_FORMAT_CUSTOM0** = **64**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM1** = **128**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM2** = **256**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM3** = **512**
|
||
|
||
- **ARRAY_FORMAT_BONES** = **1024** --- Flag used to mark a bone information array.
|
||
|
||
- **ARRAY_FORMAT_WEIGHTS** = **2048** --- Flag used to mark a weights array.
|
||
|
||
- **ARRAY_FORMAT_INDEX** = **4096** --- Flag used to mark an index array.
|
||
|
||
- **ARRAY_FORMAT_BLEND_SHAPE_MASK** = **7**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM_BASE** = **13**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM_BITS** = **3**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM0_SHIFT** = **13**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM1_SHIFT** = **16**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM2_SHIFT** = **19**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM3_SHIFT** = **22**
|
||
|
||
- **ARRAY_FORMAT_CUSTOM_MASK** = **7**
|
||
|
||
- **ARRAY_COMPRESS_FLAGS_BASE** = **25**
|
||
|
||
- **ARRAY_FLAG_USE_2D_VERTICES** = **33554432** --- Flag used to mark that the array contains 2D vertices.
|
||
|
||
- **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = **67108864**
|
||
|
||
- **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = **134217728**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_PrimitiveType:
|
||
|
||
.. _class_RenderingServer_constant_PRIMITIVE_POINTS:
|
||
|
||
.. _class_RenderingServer_constant_PRIMITIVE_LINES:
|
||
|
||
.. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP:
|
||
|
||
.. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES:
|
||
|
||
.. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP:
|
||
|
||
.. _class_RenderingServer_constant_PRIMITIVE_MAX:
|
||
|
||
enum **PrimitiveType**:
|
||
|
||
- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points.
|
||
|
||
- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines.
|
||
|
||
- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end.
|
||
|
||
- **PRIMITIVE_TRIANGLES** = **3** --- Primitive to draw consists of triangles.
|
||
|
||
- **PRIMITIVE_TRIANGLE_STRIP** = **4** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
|
||
|
||
- **PRIMITIVE_MAX** = **5** --- Represents the size of the :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_BlendShapeMode:
|
||
|
||
.. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED:
|
||
|
||
.. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE:
|
||
|
||
enum **BlendShapeMode**:
|
||
|
||
- **BLEND_SHAPE_MODE_NORMALIZED** = **0** --- Blend shapes are normalized.
|
||
|
||
- **BLEND_SHAPE_MODE_RELATIVE** = **1** --- Blend shapes are relative to base weight.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_MultimeshTransformFormat:
|
||
|
||
.. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D:
|
||
|
||
.. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D:
|
||
|
||
enum **MultimeshTransformFormat**:
|
||
|
||
- **MULTIMESH_TRANSFORM_2D** = **0** --- Use :ref:`Transform2D<class_Transform2D>` to store MultiMesh transform.
|
||
|
||
- **MULTIMESH_TRANSFORM_3D** = **1** --- Use :ref:`Transform3D<class_Transform3D>` to store MultiMesh transform.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_LightProjectorFilter:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
|
||
|
||
enum **LightProjectorFilter**:
|
||
|
||
- **LIGHT_PROJECTOR_FILTER_NEAREST** = **0**
|
||
|
||
- **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = **1**
|
||
|
||
- **LIGHT_PROJECTOR_FILTER_LINEAR** = **2**
|
||
|
||
- **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = **3**
|
||
|
||
- **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = **4**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_LightType:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_DIRECTIONAL:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_OMNI:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_SPOT:
|
||
|
||
enum **LightType**:
|
||
|
||
- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light.
|
||
|
||
- **LIGHT_OMNI** = **1** --- Is an omni light.
|
||
|
||
- **LIGHT_SPOT** = **2** --- Is a spot light.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_LightParam:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_RANGE:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SIZE:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_VOLUMETRIC_FOG_FADE:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_PARAM_MAX:
|
||
|
||
enum **LightParam**:
|
||
|
||
- **LIGHT_PARAM_ENERGY** = **0** --- The light's energy.
|
||
|
||
- **LIGHT_PARAM_INDIRECT_ENERGY** = **1**
|
||
|
||
- **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity.
|
||
|
||
- **LIGHT_PARAM_RANGE** = **3** --- The light's range.
|
||
|
||
- **LIGHT_PARAM_SIZE** = **4** --- The size of the light when using spot light or omni light. The angular size of the light when using directional light.
|
||
|
||
- **LIGHT_PARAM_ATTENUATION** = **5** --- The light's attenuation.
|
||
|
||
- **LIGHT_PARAM_SPOT_ANGLE** = **6** --- The spotlight's angle.
|
||
|
||
- **LIGHT_PARAM_SPOT_ATTENUATION** = **7** --- The spotlight's attenuation.
|
||
|
||
- **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8** --- Max distance that shadows will be rendered.
|
||
|
||
- **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9** --- Proportion of shadow atlas occupied by the first split.
|
||
|
||
- **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10** --- Proportion of shadow atlas occupied by the second split.
|
||
|
||
- **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11** --- Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
|
||
|
||
- **LIGHT_PARAM_SHADOW_FADE_START** = **12** --- Proportion of shadow max distance where the shadow will start to fade out.
|
||
|
||
- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **13** --- Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
|
||
|
||
- **LIGHT_PARAM_SHADOW_BIAS** = **14** --- Bias the shadow lookup to fix self-shadowing artifacts.
|
||
|
||
- **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = **15** --- Sets the size of the directional shadow pancake. The pancake offsets the start of the shadow's camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to ``0`` turns off the pancaking effect.
|
||
|
||
- **LIGHT_PARAM_SHADOW_BLUR** = **16** --- Blurs the edges of the shadow. Can be used to hide pixel artifacts in low resolution shadow maps. A high value can make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible.
|
||
|
||
- **LIGHT_PARAM_SHADOW_VOLUMETRIC_FOG_FADE** = **17**
|
||
|
||
- **LIGHT_PARAM_TRANSMITTANCE_BIAS** = **18**
|
||
|
||
- **LIGHT_PARAM_MAX** = **19** --- Represents the size of the :ref:`LightParam<enum_RenderingServer_LightParam>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_LightBakeMode:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_BAKE_STATIC:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC:
|
||
|
||
enum **LightBakeMode**:
|
||
|
||
- **LIGHT_BAKE_DISABLED** = **0**
|
||
|
||
- **LIGHT_BAKE_STATIC** = **1**
|
||
|
||
- **LIGHT_BAKE_DYNAMIC** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_LightOmniShadowMode:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE:
|
||
|
||
enum **LightOmniShadowMode**:
|
||
|
||
- **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0** --- Use a dual paraboloid shadow map for omni lights.
|
||
|
||
- **LIGHT_OMNI_SHADOW_CUBE** = **1** --- Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_LightDirectionalShadowMode:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS:
|
||
|
||
.. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS:
|
||
|
||
enum **LightDirectionalShadowMode**:
|
||
|
||
- **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0** --- Use orthogonal shadow projection for directional light.
|
||
|
||
- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1** --- Use 2 splits for shadow projection when using directional light.
|
||
|
||
- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2** --- Use 4 splits for shadow projection when using directional light.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ShadowQuality:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_QUALITY_HARD:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_QUALITY_MAX:
|
||
|
||
enum **ShadowQuality**:
|
||
|
||
- **SHADOW_QUALITY_HARD** = **0** --- Lowest shadow filtering quality (fastest). Soft shadows are not available with this quality setting, which means the :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` property is ignored if :ref:`Light3D.light_size<class_Light3D_property_light_size>` and :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is ``0.0``.
|
||
|
||
\ **Note:** The variable shadow blur performed by :ref:`Light3D.light_size<class_Light3D_property_light_size>` and :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is still effective when using hard shadow filtering. In this case, :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` *is* taken into account. However, the results will not be blurred, instead the blur amount is treated as a maximum radius for the penumbra.
|
||
|
||
- **SHADOW_QUALITY_SOFT_VERY_LOW** = **1** --- Very low shadow filtering quality (faster). When using this quality setting, :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` is automatically multiplied by 0.75× to avoid introducing too much noise. This division only applies to lights whose :ref:`Light3D.light_size<class_Light3D_property_light_size>` or :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is ``0.0``).
|
||
|
||
- **SHADOW_QUALITY_SOFT_LOW** = **2** --- Low shadow filtering quality (fast).
|
||
|
||
- **SHADOW_QUALITY_SOFT_MEDIUM** = **3** --- Medium low shadow filtering quality (average).
|
||
|
||
- **SHADOW_QUALITY_SOFT_HIGH** = **4** --- High low shadow filtering quality (slow). When using this quality setting, :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` is automatically multiplied by 1.5× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose :ref:`Light3D.light_size<class_Light3D_property_light_size>` or :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is ``0.0``).
|
||
|
||
- **SHADOW_QUALITY_SOFT_ULTRA** = **5** --- Highest low shadow filtering quality (slowest). When using this quality setting, :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` is automatically multiplied by 2× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose :ref:`Light3D.light_size<class_Light3D_property_light_size>` or :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is ``0.0``).
|
||
|
||
- **SHADOW_QUALITY_MAX** = **6**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ReflectionProbeUpdateMode:
|
||
|
||
.. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE:
|
||
|
||
.. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS:
|
||
|
||
enum **ReflectionProbeUpdateMode**:
|
||
|
||
- **REFLECTION_PROBE_UPDATE_ONCE** = **0** --- Reflection probe will update reflections once and then stop.
|
||
|
||
- **REFLECTION_PROBE_UPDATE_ALWAYS** = **1** --- Reflection probe will update each frame. This mode is necessary to capture moving objects.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ReflectionProbeAmbientMode:
|
||
|
||
.. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT:
|
||
|
||
.. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR:
|
||
|
||
enum **ReflectionProbeAmbientMode**:
|
||
|
||
- **REFLECTION_PROBE_AMBIENT_DISABLED** = **0**
|
||
|
||
- **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = **1**
|
||
|
||
- **REFLECTION_PROBE_AMBIENT_COLOR** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_DecalTexture:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_TEXTURE_ORM:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_TEXTURE_MAX:
|
||
|
||
enum **DecalTexture**:
|
||
|
||
- **DECAL_TEXTURE_ALBEDO** = **0**
|
||
|
||
- **DECAL_TEXTURE_NORMAL** = **1**
|
||
|
||
- **DECAL_TEXTURE_ORM** = **2**
|
||
|
||
- **DECAL_TEXTURE_EMISSION** = **3**
|
||
|
||
- **DECAL_TEXTURE_MAX** = **4**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_DecalFilter:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_FILTER_NEAREST:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_FILTER_LINEAR:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS:
|
||
|
||
.. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
|
||
|
||
enum **DecalFilter**:
|
||
|
||
- **DECAL_FILTER_NEAREST** = **0**
|
||
|
||
- **DECAL_FILTER_NEAREST_MIPMAPS** = **1**
|
||
|
||
- **DECAL_FILTER_LINEAR** = **2**
|
||
|
||
- **DECAL_FILTER_LINEAR_MIPMAPS** = **3**
|
||
|
||
- **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = **4**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_VoxelGIQuality:
|
||
|
||
.. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH:
|
||
|
||
enum **VoxelGIQuality**:
|
||
|
||
- **VOXEL_GI_QUALITY_LOW** = **0**
|
||
|
||
- **VOXEL_GI_QUALITY_HIGH** = **1**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ParticlesMode:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_MODE_2D:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_MODE_3D:
|
||
|
||
enum **ParticlesMode**:
|
||
|
||
- **PARTICLES_MODE_2D** = **0**
|
||
|
||
- **PARTICLES_MODE_3D** = **1**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ParticlesTransformAlign:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY:
|
||
|
||
enum **ParticlesTransformAlign**:
|
||
|
||
- **PARTICLES_TRANSFORM_ALIGN_DISABLED** = **0**
|
||
|
||
- **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = **1**
|
||
|
||
- **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = **2**
|
||
|
||
- **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = **3**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ParticlesDrawOrder:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH:
|
||
|
||
enum **ParticlesDrawOrder**:
|
||
|
||
- **PARTICLES_DRAW_ORDER_INDEX** = **0** --- Draw particles in the order that they appear in the particles array.
|
||
|
||
- **PARTICLES_DRAW_ORDER_LIFETIME** = **1** --- Sort particles based on their lifetime.
|
||
|
||
- **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = **2**
|
||
|
||
- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **3** --- Sort particles based on their distance to the camera.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ParticlesCollisionType:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE:
|
||
|
||
enum **ParticlesCollisionType**:
|
||
|
||
- **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = **0**
|
||
|
||
- **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = **1**
|
||
|
||
- **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = **2**
|
||
|
||
- **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = **3**
|
||
|
||
- **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = **4**
|
||
|
||
- **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = **5**
|
||
|
||
- **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = **6**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX:
|
||
|
||
enum **ParticlesCollisionHeightfieldResolution**:
|
||
|
||
- **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = **0**
|
||
|
||
- **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = **1**
|
||
|
||
- **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = **2**
|
||
|
||
- **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = **3**
|
||
|
||
- **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = **4**
|
||
|
||
- **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = **5**
|
||
|
||
- **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = **6**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_FogVolumeShape:
|
||
|
||
.. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID:
|
||
|
||
.. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX:
|
||
|
||
.. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD:
|
||
|
||
enum **FogVolumeShape**:
|
||
|
||
- **FOG_VOLUME_SHAPE_ELLIPSOID** = **0** --- :ref:`FogVolume<class_FogVolume>` will be shaped like an ellipsoid.
|
||
|
||
- **FOG_VOLUME_SHAPE_BOX** = **1** --- :ref:`FogVolume<class_FogVolume>` will be shaped like a box.
|
||
|
||
- **FOG_VOLUME_SHAPE_WORLD** = **2** --- :ref:`FogVolume<class_FogVolume>` will have no shape, will cover the whole world and will not be culled.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportScaling3DMode:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX:
|
||
|
||
enum **ViewportScaling3DMode**:
|
||
|
||
- **VIEWPORT_SCALING_3D_MODE_BILINEAR** = **0** --- Enables bilinear scaling on 3D viewports. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less then ``1.0`` will result in undersampling while values greater than ``1.0`` will result in supersampling. A value of ``1.0`` disables scaling.
|
||
|
||
- **VIEWPORT_SCALING_3D_MODE_FSR** = **1** --- Enables FSR upscaling on 3D viewports. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less then ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear supersampling will be used instead. A value of ``1.0`` disables scaling.
|
||
|
||
- **VIEWPORT_SCALING_3D_MODE_MAX** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportUpdateMode:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS:
|
||
|
||
enum **ViewportUpdateMode**:
|
||
|
||
- **VIEWPORT_UPDATE_DISABLED** = **0** --- Do not update the viewport.
|
||
|
||
- **VIEWPORT_UPDATE_ONCE** = **1** --- Update the viewport once then set to disabled.
|
||
|
||
- **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2** --- Update the viewport whenever it is visible.
|
||
|
||
- **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = **3**
|
||
|
||
- **VIEWPORT_UPDATE_ALWAYS** = **4** --- Always update the viewport.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportClearMode:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME:
|
||
|
||
enum **ViewportClearMode**:
|
||
|
||
- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing.
|
||
|
||
- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing.
|
||
|
||
- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to :ref:`VIEWPORT_CLEAR_NEVER<class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER>`.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportSDFOversize:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX:
|
||
|
||
enum **ViewportSDFOversize**:
|
||
|
||
- **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = **0**
|
||
|
||
- **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = **1**
|
||
|
||
- **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = **2**
|
||
|
||
- **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = **3**
|
||
|
||
- **VIEWPORT_SDF_OVERSIZE_MAX** = **4**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportSDFScale:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX:
|
||
|
||
enum **ViewportSDFScale**:
|
||
|
||
- **VIEWPORT_SDF_SCALE_100_PERCENT** = **0**
|
||
|
||
- **VIEWPORT_SDF_SCALE_50_PERCENT** = **1**
|
||
|
||
- **VIEWPORT_SDF_SCALE_25_PERCENT** = **2**
|
||
|
||
- **VIEWPORT_SDF_SCALE_MAX** = **3**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportMSAA:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_MSAA_2X:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_MSAA_4X:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_MSAA_8X:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX:
|
||
|
||
enum **ViewportMSAA**:
|
||
|
||
- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
|
||
|
||
- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
|
||
|
||
- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
|
||
|
||
- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing uses 8 samples per pixel for 3D. This has a very high impact on performance. Likely unsupported on low-end and older hardware.
|
||
|
||
- **VIEWPORT_MSAA_MAX** = **4**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportScreenSpaceAA:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX:
|
||
|
||
enum **ViewportScreenSpaceAA**:
|
||
|
||
- **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = **0**
|
||
|
||
- **VIEWPORT_SCREEN_SPACE_AA_FXAA** = **1**
|
||
|
||
- **VIEWPORT_SCREEN_SPACE_AA_MAX** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH:
|
||
|
||
enum **ViewportOcclusionCullingBuildQuality**:
|
||
|
||
- **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = **0**
|
||
|
||
- **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = **1**
|
||
|
||
- **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportRenderInfo:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX:
|
||
|
||
enum **ViewportRenderInfo**:
|
||
|
||
- **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0** --- Number of objects drawn in a single frame.
|
||
|
||
- **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = **1** --- Number of vertices drawn in a single frame.
|
||
|
||
- **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **2** --- Number of draw calls during this frame.
|
||
|
||
- **VIEWPORT_RENDER_INFO_MAX** = **3** --- Represents the size of the :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportRenderInfoType:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX:
|
||
|
||
enum **ViewportRenderInfoType**:
|
||
|
||
- **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = **0**
|
||
|
||
- **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = **1**
|
||
|
||
- **VIEWPORT_RENDER_INFO_TYPE_MAX** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ViewportDebugDraw:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES:
|
||
|
||
.. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS:
|
||
|
||
enum **ViewportDebugDraw**:
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Objects are displayed without light information.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_LIGHTING** = **2** --- Objects are displayed with only light information.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **3** --- Objects are displayed semi-transparent with additive blending so you can see where they are drawing over top of one another. A higher overdraw (represented by brighter colors) means you are wasting performance on drawing pixels that are being hidden behind others.
|
||
|
||
\ **Note:** When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **4** --- Debug draw draws objects in wireframe.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = **5** --- Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = **6** --- Objects are displayed with only the albedo value from :ref:`VoxelGI<class_VoxelGI>`\ s.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = **7** --- Objects are displayed with only the lighting value from :ref:`VoxelGI<class_VoxelGI>`\ s.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = **8** --- Objects are displayed with only the emission color from :ref:`VoxelGI<class_VoxelGI>`\ s.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = **9** --- Draws the shadow atlas that stores shadows from :ref:`OmniLight3D<class_OmniLight3D>`\ s and :ref:`SpotLight3D<class_SpotLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = **10** --- Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = **11**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_SSAO** = **12** --- Draws the screen space ambient occlusion texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have :ref:`Environment.ssao_enabled<class_Environment_property_ssao_enabled>` set in your :ref:`WorldEnvironment<class_WorldEnvironment>`.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_SSIL** = **13** --- Draws the screen space indirect lighting texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have :ref:`Environment.ssil_enabled<class_Environment_property_ssil_enabled>` set in your :ref:`WorldEnvironment<class_WorldEnvironment>`.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = **14** --- Colors each PSSM split for the :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the scene a different color so you can see where the splits are. In order they will be colored red, green, blue, yellow.
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = **15**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_SDFGI** = **16**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = **17**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = **18**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = **19**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = **20**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = **21**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = **22**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = **23**
|
||
|
||
- **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = **24**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_SkyMode:
|
||
|
||
.. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC:
|
||
|
||
.. _class_RenderingServer_constant_SKY_MODE_QUALITY:
|
||
|
||
.. _class_RenderingServer_constant_SKY_MODE_INCREMENTAL:
|
||
|
||
.. _class_RenderingServer_constant_SKY_MODE_REALTIME:
|
||
|
||
enum **SkyMode**:
|
||
|
||
- **SKY_MODE_AUTOMATIC** = **0**
|
||
|
||
- **SKY_MODE_QUALITY** = **1** --- Uses high quality importance sampling to process the radiance map. In general, this results in much higher quality than :ref:`Sky.PROCESS_MODE_REALTIME<class_Sky_constant_PROCESS_MODE_REALTIME>` but takes much longer to generate. This should not be used if you plan on changing the sky at runtime. If you are finding that the reflection is not blurry enough and is showing sparkles or fireflies, try increasing :ref:`ProjectSettings.rendering/reflections/sky_reflections/ggx_samples<class_ProjectSettings_property_rendering/reflections/sky_reflections/ggx_samples>`.
|
||
|
||
- **SKY_MODE_INCREMENTAL** = **2**
|
||
|
||
- **SKY_MODE_REALTIME** = **3** --- Uses the fast filtering algorithm to process the radiance map. In general this results in lower quality, but substantially faster run times.
|
||
|
||
\ **Note:** The fast filtering algorithm is limited to 256x256 cubemaps, so :ref:`Sky.radiance_size<class_Sky_property_radiance_size>` must be set to :ref:`Sky.RADIANCE_SIZE_256<class_Sky_constant_RADIANCE_SIZE_256>`.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentBG:
|
||
|
||
.. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR:
|
||
|
||
.. _class_RenderingServer_constant_ENV_BG_COLOR:
|
||
|
||
.. _class_RenderingServer_constant_ENV_BG_SKY:
|
||
|
||
.. _class_RenderingServer_constant_ENV_BG_CANVAS:
|
||
|
||
.. _class_RenderingServer_constant_ENV_BG_KEEP:
|
||
|
||
.. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED:
|
||
|
||
.. _class_RenderingServer_constant_ENV_BG_MAX:
|
||
|
||
enum **EnvironmentBG**:
|
||
|
||
- **ENV_BG_CLEAR_COLOR** = **0** --- Use the clear color as background.
|
||
|
||
- **ENV_BG_COLOR** = **1** --- Use a specified color as the background.
|
||
|
||
- **ENV_BG_SKY** = **2** --- Use a sky resource for the background.
|
||
|
||
- **ENV_BG_CANVAS** = **3** --- Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
|
||
|
||
- **ENV_BG_KEEP** = **4** --- Do not clear the background, use whatever was rendered last frame as the background.
|
||
|
||
- **ENV_BG_CAMERA_FEED** = **5** --- Displays a camera feed in the background.
|
||
|
||
- **ENV_BG_MAX** = **6** --- Represents the size of the :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentAmbientSource:
|
||
|
||
.. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG:
|
||
|
||
.. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR:
|
||
|
||
.. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY:
|
||
|
||
enum **EnvironmentAmbientSource**:
|
||
|
||
- **ENV_AMBIENT_SOURCE_BG** = **0** --- Gather ambient light from whichever source is specified as the background.
|
||
|
||
- **ENV_AMBIENT_SOURCE_DISABLED** = **1** --- Disable ambient light.
|
||
|
||
- **ENV_AMBIENT_SOURCE_COLOR** = **2** --- Specify a specific :ref:`Color<class_Color>` for ambient light.
|
||
|
||
- **ENV_AMBIENT_SOURCE_SKY** = **3** --- Gather ambient light from the :ref:`Sky<class_Sky>` regardless of what the background is.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentReflectionSource:
|
||
|
||
.. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG:
|
||
|
||
.. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY:
|
||
|
||
enum **EnvironmentReflectionSource**:
|
||
|
||
- **ENV_REFLECTION_SOURCE_BG** = **0** --- Use the background for reflections.
|
||
|
||
- **ENV_REFLECTION_SOURCE_DISABLED** = **1** --- Disable reflections.
|
||
|
||
- **ENV_REFLECTION_SOURCE_SKY** = **2** --- Use the :ref:`Sky<class_Sky>` for reflections regardless of what the background is.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentGlowBlendMode:
|
||
|
||
.. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE:
|
||
|
||
.. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN:
|
||
|
||
.. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT:
|
||
|
||
.. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE:
|
||
|
||
.. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX:
|
||
|
||
enum **EnvironmentGlowBlendMode**:
|
||
|
||
- **ENV_GLOW_BLEND_MODE_ADDITIVE** = **0** --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
|
||
|
||
- **ENV_GLOW_BLEND_MODE_SCREEN** = **1** --- Screen glow blending mode. Increases brightness, used frequently with bloom.
|
||
|
||
- **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = **2** --- Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
|
||
|
||
- **ENV_GLOW_BLEND_MODE_REPLACE** = **3** --- Replace glow blending mode. Replaces all pixels' color by the glow value. This can be used to simulate a full-screen blur effect by tweaking the glow parameters to match the original image's brightness.
|
||
|
||
- **ENV_GLOW_BLEND_MODE_MIX** = **4** --- Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentToneMapper:
|
||
|
||
.. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR:
|
||
|
||
.. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD:
|
||
|
||
.. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC:
|
||
|
||
.. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES:
|
||
|
||
enum **EnvironmentToneMapper**:
|
||
|
||
- **ENV_TONE_MAPPER_LINEAR** = **0** --- Output color as they came in.
|
||
|
||
- **ENV_TONE_MAPPER_REINHARD** = **1** --- Use the Reinhard tonemapper.
|
||
|
||
- **ENV_TONE_MAPPER_FILMIC** = **2** --- Use the filmic tonemapper.
|
||
|
||
- **ENV_TONE_MAPPER_ACES** = **3** --- Use the ACES tonemapper.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentSSRRoughnessQuality:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSR_ROUGNESS_QUALITY_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSR_ROUGNESS_QUALITY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSR_ROUGNESS_QUALITY_MEDIUM:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSR_ROUGNESS_QUALITY_HIGH:
|
||
|
||
enum **EnvironmentSSRRoughnessQuality**:
|
||
|
||
- **ENV_SSR_ROUGNESS_QUALITY_DISABLED** = **0**
|
||
|
||
- **ENV_SSR_ROUGNESS_QUALITY_LOW** = **1**
|
||
|
||
- **ENV_SSR_ROUGNESS_QUALITY_MEDIUM** = **2**
|
||
|
||
- **ENV_SSR_ROUGNESS_QUALITY_HIGH** = **3**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentSSAOQuality:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA:
|
||
|
||
enum **EnvironmentSSAOQuality**:
|
||
|
||
- **ENV_SSAO_QUALITY_VERY_LOW** = **0** --- Lowest quality of screen-space ambient occlusion.
|
||
|
||
- **ENV_SSAO_QUALITY_LOW** = **1** --- Low quality screen-space ambient occlusion.
|
||
|
||
- **ENV_SSAO_QUALITY_MEDIUM** = **2** --- Medium quality screen-space ambient occlusion.
|
||
|
||
- **ENV_SSAO_QUALITY_HIGH** = **3** --- High quality screen-space ambient occlusion.
|
||
|
||
- **ENV_SSAO_QUALITY_ULTRA** = **4** --- Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentSSILQuality:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA:
|
||
|
||
enum **EnvironmentSSILQuality**:
|
||
|
||
- **ENV_SSIL_QUALITY_VERY_LOW** = **0** --- Lowest quality of screen-space indirect lighting.
|
||
|
||
- **ENV_SSIL_QUALITY_LOW** = **1** --- Low quality screen-space indirect lighting.
|
||
|
||
- **ENV_SSIL_QUALITY_MEDIUM** = **2** --- High quality screen-space indirect lighting.
|
||
|
||
- **ENV_SSIL_QUALITY_HIGH** = **3** --- High quality screen-space indirect lighting.
|
||
|
||
- **ENV_SSIL_QUALITY_ULTRA** = **4** --- Highest quality screen-space indirect lighting. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentSDFGIYScale:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT:
|
||
|
||
enum **EnvironmentSDFGIYScale**:
|
||
|
||
- **ENV_SDFGI_Y_SCALE_50_PERCENT** = **0**
|
||
|
||
- **ENV_SDFGI_Y_SCALE_75_PERCENT** = **1**
|
||
|
||
- **ENV_SDFGI_Y_SCALE_100_PERCENT** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentSDFGIRayCount:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX:
|
||
|
||
enum **EnvironmentSDFGIRayCount**:
|
||
|
||
- **ENV_SDFGI_RAY_COUNT_4** = **0**
|
||
|
||
- **ENV_SDFGI_RAY_COUNT_8** = **1**
|
||
|
||
- **ENV_SDFGI_RAY_COUNT_16** = **2**
|
||
|
||
- **ENV_SDFGI_RAY_COUNT_32** = **3**
|
||
|
||
- **ENV_SDFGI_RAY_COUNT_64** = **4**
|
||
|
||
- **ENV_SDFGI_RAY_COUNT_96** = **5**
|
||
|
||
- **ENV_SDFGI_RAY_COUNT_128** = **6**
|
||
|
||
- **ENV_SDFGI_RAY_COUNT_MAX** = **7**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX:
|
||
|
||
enum **EnvironmentSDFGIFramesToConverge**:
|
||
|
||
- **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = **0**
|
||
|
||
- **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = **1**
|
||
|
||
- **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = **2**
|
||
|
||
- **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = **3**
|
||
|
||
- **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = **4**
|
||
|
||
- **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = **5**
|
||
|
||
- **ENV_SDFGI_CONVERGE_MAX** = **6**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES:
|
||
|
||
.. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX:
|
||
|
||
enum **EnvironmentSDFGIFramesToUpdateLight**:
|
||
|
||
- **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = **0**
|
||
|
||
- **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = **1**
|
||
|
||
- **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = **2**
|
||
|
||
- **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = **3**
|
||
|
||
- **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = **4**
|
||
|
||
- **ENV_SDFGI_UPDATE_LIGHT_MAX** = **5**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_SubSurfaceScatteringQuality:
|
||
|
||
.. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM:
|
||
|
||
.. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH:
|
||
|
||
enum **SubSurfaceScatteringQuality**:
|
||
|
||
- **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = **0**
|
||
|
||
- **SUB_SURFACE_SCATTERING_QUALITY_LOW** = **1**
|
||
|
||
- **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = **2**
|
||
|
||
- **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = **3**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_DOFBokehShape:
|
||
|
||
.. _class_RenderingServer_constant_DOF_BOKEH_BOX:
|
||
|
||
.. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON:
|
||
|
||
.. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE:
|
||
|
||
enum **DOFBokehShape**:
|
||
|
||
- **DOF_BOKEH_BOX** = **0** --- Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
|
||
|
||
- **DOF_BOKEH_HEXAGON** = **1** --- Calculates DOF blur using a hexagon shaped filter.
|
||
|
||
- **DOF_BOKEH_CIRCLE** = **2** --- Calculates DOF blur using a circle shaped filter. Best quality and most realistic, but slowest. Use only for areas where a lot of performance can be dedicated to post-processing (e.g. cutscenes).
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_DOFBlurQuality:
|
||
|
||
.. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW:
|
||
|
||
.. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM:
|
||
|
||
.. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH:
|
||
|
||
enum **DOFBlurQuality**:
|
||
|
||
- **DOF_BLUR_QUALITY_VERY_LOW** = **0** --- Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
|
||
|
||
- **DOF_BLUR_QUALITY_LOW** = **1** --- Low quality DOF blur.
|
||
|
||
- **DOF_BLUR_QUALITY_MEDIUM** = **2** --- Medium quality DOF blur.
|
||
|
||
- **DOF_BLUR_QUALITY_HIGH** = **3** --- Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_InstanceType:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_NONE:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_MESH:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_MULTIMESH:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_PARTICLES:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_LIGHT:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_DECAL:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_VOXEL_GI:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_LIGHTMAP:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_OCCLUDER:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_MAX:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK:
|
||
|
||
enum **InstanceType**:
|
||
|
||
- **INSTANCE_NONE** = **0** --- The instance does not have a type.
|
||
|
||
- **INSTANCE_MESH** = **1** --- The instance is a mesh.
|
||
|
||
- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh.
|
||
|
||
- **INSTANCE_PARTICLES** = **3** --- The instance is a particle emitter.
|
||
|
||
- **INSTANCE_PARTICLES_COLLISION** = **4**
|
||
|
||
- **INSTANCE_LIGHT** = **5** --- The instance is a light.
|
||
|
||
- **INSTANCE_REFLECTION_PROBE** = **6** --- The instance is a reflection probe.
|
||
|
||
- **INSTANCE_DECAL** = **7** --- The instance is a decal.
|
||
|
||
- **INSTANCE_VOXEL_GI** = **8** --- The instance is a VoxelGI.
|
||
|
||
- **INSTANCE_LIGHTMAP** = **9** --- The instance is a lightmap.
|
||
|
||
- **INSTANCE_OCCLUDER** = **10**
|
||
|
||
- **INSTANCE_VISIBLITY_NOTIFIER** = **11**
|
||
|
||
- **INSTANCE_FOG_VOLUME** = **12**
|
||
|
||
- **INSTANCE_MAX** = **13** --- Represents the size of the :ref:`InstanceType<enum_RenderingServer_InstanceType>` enum.
|
||
|
||
- **INSTANCE_GEOMETRY_MASK** = **14** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_InstanceFlags:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING:
|
||
|
||
.. _class_RenderingServer_constant_INSTANCE_FLAG_MAX:
|
||
|
||
enum **InstanceFlags**:
|
||
|
||
- **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0** --- Allows the instance to be used in baked lighting.
|
||
|
||
- **INSTANCE_FLAG_USE_DYNAMIC_GI** = **1** --- Allows the instance to be used with dynamic global illumination.
|
||
|
||
- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **2** --- When set, manually requests to draw geometry on next frame.
|
||
|
||
- **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = **3**
|
||
|
||
- **INSTANCE_FLAG_MAX** = **4** --- Represents the size of the :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_ShadowCastingSetting:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED:
|
||
|
||
.. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY:
|
||
|
||
enum **ShadowCastingSetting**:
|
||
|
||
- **SHADOW_CASTING_SETTING_OFF** = **0** --- Disable shadows from this instance.
|
||
|
||
- **SHADOW_CASTING_SETTING_ON** = **1** --- Cast shadows from this instance.
|
||
|
||
- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2** --- Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
|
||
|
||
- **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3** --- Only render the shadows from the object. The object itself will not be drawn.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_VisibilityRangeFadeMode:
|
||
|
||
.. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF:
|
||
|
||
.. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES:
|
||
|
||
enum **VisibilityRangeFadeMode**:
|
||
|
||
- **VISIBILITY_RANGE_FADE_DISABLED** = **0** --- Disable visibility range fading for the given instance.
|
||
|
||
- **VISIBILITY_RANGE_FADE_SELF** = **1** --- Fade-out the given instance when it approaches its visibility range limits.
|
||
|
||
- **VISIBILITY_RANGE_FADE_DEPENDENCIES** = **2** --- Fade-in the given instance's dependencies when reaching its visibility range limits.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_BakeChannels:
|
||
|
||
.. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA:
|
||
|
||
.. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL:
|
||
|
||
.. _class_RenderingServer_constant_BAKE_CHANNEL_ORM:
|
||
|
||
.. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION:
|
||
|
||
enum **BakeChannels**:
|
||
|
||
- **BAKE_CHANNEL_ALBEDO_ALPHA** = **0**
|
||
|
||
- **BAKE_CHANNEL_NORMAL** = **1**
|
||
|
||
- **BAKE_CHANNEL_ORM** = **2**
|
||
|
||
- **BAKE_CHANNEL_EMISSION** = **3**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CanvasTextureChannel:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR:
|
||
|
||
enum **CanvasTextureChannel**:
|
||
|
||
- **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = **0**
|
||
|
||
- **CANVAS_TEXTURE_CHANNEL_NORMAL** = **1**
|
||
|
||
- **CANVAS_TEXTURE_CHANNEL_SPECULAR** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_NinePatchAxisMode:
|
||
|
||
.. _class_RenderingServer_constant_NINE_PATCH_STRETCH:
|
||
|
||
.. _class_RenderingServer_constant_NINE_PATCH_TILE:
|
||
|
||
.. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT:
|
||
|
||
enum **NinePatchAxisMode**:
|
||
|
||
- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed.
|
||
|
||
- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed.
|
||
|
||
- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CanvasItemTextureFilter:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX:
|
||
|
||
enum **CanvasItemTextureFilter**:
|
||
|
||
- **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = **0** --- Uses the default filter mode for this :ref:`Viewport<class_Viewport>`.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = **1** --- The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = **2** --- The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = **3** --- The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = **4** --- The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = **5** --- The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = **6** --- The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_FILTER_MAX** = **7** --- Max value for :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CanvasItemTextureRepeat:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX:
|
||
|
||
enum **CanvasItemTextureRepeat**:
|
||
|
||
- **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = **0** --- Uses the default repeat mode for this :ref:`Viewport<class_Viewport>`.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = **1** --- Disables textures repeating. Instead, when reading UVs outside the 0-1 range, the value will be clamped to the edge of the texture, resulting in a stretched out look at the borders of the texture.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = **2** --- Enables the texture to repeat when UV coordinates are outside the 0-1 range. If using one of the linear filtering modes, this can result in artifacts at the edges of a texture when the sampler filters across the edges of the texture.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = **3** --- Flip the texture when repeating so that the edge lines up instead of abruptly changing.
|
||
|
||
- **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = **4** --- Max value for :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CanvasGroupMode:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_GROUP_MODE_OPAQUE:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT:
|
||
|
||
enum **CanvasGroupMode**:
|
||
|
||
- **CANVAS_GROUP_MODE_DISABLED** = **0**
|
||
|
||
- **CANVAS_GROUP_MODE_OPAQUE** = **1**
|
||
|
||
- **CANVAS_GROUP_MODE_TRANSPARENT** = **2**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CanvasLightMode:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL:
|
||
|
||
enum **CanvasLightMode**:
|
||
|
||
- **CANVAS_LIGHT_MODE_POINT** = **0**
|
||
|
||
- **CANVAS_LIGHT_MODE_DIRECTIONAL** = **1**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CanvasLightBlendMode:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX:
|
||
|
||
enum **CanvasLightBlendMode**:
|
||
|
||
- **CANVAS_LIGHT_BLEND_MODE_ADD** = **0** --- Adds light color additive to the canvas.
|
||
|
||
- **CANVAS_LIGHT_BLEND_MODE_SUB** = **1** --- Adds light color subtractive to the canvas.
|
||
|
||
- **CANVAS_LIGHT_BLEND_MODE_MIX** = **2** --- The light adds color depending on transparency.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CanvasLightShadowFilter:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX:
|
||
|
||
enum **CanvasLightShadowFilter**:
|
||
|
||
- **CANVAS_LIGHT_FILTER_NONE** = **0** --- Do not apply a filter to canvas light shadows.
|
||
|
||
- **CANVAS_LIGHT_FILTER_PCF5** = **1** --- Use PCF5 filtering to filter canvas light shadows.
|
||
|
||
- **CANVAS_LIGHT_FILTER_PCF13** = **2** --- Use PCF13 filtering to filter canvas light shadows.
|
||
|
||
- **CANVAS_LIGHT_FILTER_MAX** = **3** --- Max value of the :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` enum.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_CanvasOccluderPolygonCullMode:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE:
|
||
|
||
enum **CanvasOccluderPolygonCullMode**:
|
||
|
||
- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled.
|
||
|
||
- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise.
|
||
|
||
- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise.
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_GlobalVariableType:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE:
|
||
|
||
.. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX:
|
||
|
||
enum **GlobalVariableType**:
|
||
|
||
- **GLOBAL_VAR_TYPE_BOOL** = **0**
|
||
|
||
- **GLOBAL_VAR_TYPE_BVEC2** = **1**
|
||
|
||
- **GLOBAL_VAR_TYPE_BVEC3** = **2**
|
||
|
||
- **GLOBAL_VAR_TYPE_BVEC4** = **3**
|
||
|
||
- **GLOBAL_VAR_TYPE_INT** = **4**
|
||
|
||
- **GLOBAL_VAR_TYPE_IVEC2** = **5**
|
||
|
||
- **GLOBAL_VAR_TYPE_IVEC3** = **6**
|
||
|
||
- **GLOBAL_VAR_TYPE_IVEC4** = **7**
|
||
|
||
- **GLOBAL_VAR_TYPE_RECT2I** = **8**
|
||
|
||
- **GLOBAL_VAR_TYPE_UINT** = **9**
|
||
|
||
- **GLOBAL_VAR_TYPE_UVEC2** = **10**
|
||
|
||
- **GLOBAL_VAR_TYPE_UVEC3** = **11**
|
||
|
||
- **GLOBAL_VAR_TYPE_UVEC4** = **12**
|
||
|
||
- **GLOBAL_VAR_TYPE_FLOAT** = **13**
|
||
|
||
- **GLOBAL_VAR_TYPE_VEC2** = **14**
|
||
|
||
- **GLOBAL_VAR_TYPE_VEC3** = **15**
|
||
|
||
- **GLOBAL_VAR_TYPE_VEC4** = **16**
|
||
|
||
- **GLOBAL_VAR_TYPE_COLOR** = **17**
|
||
|
||
- **GLOBAL_VAR_TYPE_RECT2** = **18**
|
||
|
||
- **GLOBAL_VAR_TYPE_MAT2** = **19**
|
||
|
||
- **GLOBAL_VAR_TYPE_MAT3** = **20**
|
||
|
||
- **GLOBAL_VAR_TYPE_MAT4** = **21**
|
||
|
||
- **GLOBAL_VAR_TYPE_TRANSFORM_2D** = **22**
|
||
|
||
- **GLOBAL_VAR_TYPE_TRANSFORM** = **23**
|
||
|
||
- **GLOBAL_VAR_TYPE_SAMPLER2D** = **24**
|
||
|
||
- **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = **25**
|
||
|
||
- **GLOBAL_VAR_TYPE_SAMPLER3D** = **26**
|
||
|
||
- **GLOBAL_VAR_TYPE_SAMPLERCUBE** = **27**
|
||
|
||
- **GLOBAL_VAR_TYPE_MAX** = **28**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_RenderingInfo:
|
||
|
||
.. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME:
|
||
|
||
.. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME:
|
||
|
||
.. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME:
|
||
|
||
.. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED:
|
||
|
||
.. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED:
|
||
|
||
.. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED:
|
||
|
||
enum **RenderingInfo**:
|
||
|
||
- **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = **0**
|
||
|
||
- **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = **1**
|
||
|
||
- **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = **2**
|
||
|
||
- **RENDERING_INFO_TEXTURE_MEM_USED** = **3**
|
||
|
||
- **RENDERING_INFO_BUFFER_MEM_USED** = **4**
|
||
|
||
- **RENDERING_INFO_VIDEO_MEM_USED** = **5**
|
||
|
||
----
|
||
|
||
.. _enum_RenderingServer_Features:
|
||
|
||
.. _class_RenderingServer_constant_FEATURE_SHADERS:
|
||
|
||
.. _class_RenderingServer_constant_FEATURE_MULTITHREADED:
|
||
|
||
enum **Features**:
|
||
|
||
- **FEATURE_SHADERS** = **0** --- Hardware supports shaders. This enum is currently unused in Godot 3.x.
|
||
|
||
- **FEATURE_MULTITHREADED** = **1** --- Hardware supports multithreading. This enum is currently unused in Godot 3.x.
|
||
|
||
Constants
|
||
---------
|
||
|
||
.. _class_RenderingServer_constant_NO_INDEX_ARRAY:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN:
|
||
|
||
.. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX:
|
||
|
||
.. _class_RenderingServer_constant_MAX_GLOW_LEVELS:
|
||
|
||
.. _class_RenderingServer_constant_MAX_CURSORS:
|
||
|
||
.. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS:
|
||
|
||
.. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN:
|
||
|
||
.. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX:
|
||
|
||
.. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR:
|
||
|
||
.. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM:
|
||
|
||
- **NO_INDEX_ARRAY** = **-1** --- Marks an error that shows that the index array is empty.
|
||
|
||
- **ARRAY_WEIGHTS_SIZE** = **4** --- Number of weights/bones per vertex.
|
||
|
||
- **CANVAS_ITEM_Z_MIN** = **-4096** --- The minimum Z-layer for canvas items.
|
||
|
||
- **CANVAS_ITEM_Z_MAX** = **4096** --- The maximum Z-layer for canvas items.
|
||
|
||
- **MAX_GLOW_LEVELS** = **7** --- Max number of glow levels that can be used with glow post-process effect.
|
||
|
||
- **MAX_CURSORS** = **8** --- Unused enum in Godot 3.x.
|
||
|
||
- **MAX_2D_DIRECTIONAL_LIGHTS** = **8**
|
||
|
||
- **MATERIAL_RENDER_PRIORITY_MIN** = **-128** --- The minimum renderpriority of all materials.
|
||
|
||
- **MATERIAL_RENDER_PRIORITY_MAX** = **127** --- The maximum renderpriority of all materials.
|
||
|
||
- **ARRAY_CUSTOM_COUNT** = **4**
|
||
|
||
- **PARTICLES_EMIT_FLAG_POSITION** = **1**
|
||
|
||
- **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = **2**
|
||
|
||
- **PARTICLES_EMIT_FLAG_VELOCITY** = **4**
|
||
|
||
- **PARTICLES_EMIT_FLAG_COLOR** = **8**
|
||
|
||
- **PARTICLES_EMIT_FLAG_CUSTOM** = **16**
|
||
|
||
Property Descriptions
|
||
---------------------
|
||
|
||
.. _class_RenderingServer_property_render_loop_enabled:
|
||
|
||
- :ref:`bool<class_bool>` **render_loop_enabled**
|
||
|
||
+----------+--------------------------------+
|
||
| *Setter* | set_render_loop_enabled(value) |
|
||
+----------+--------------------------------+
|
||
| *Getter* | is_render_loop_enabled() |
|
||
+----------+--------------------------------+
|
||
|
||
If ``false``, disables rendering completely, but the engine logic is still being processed. You can call :ref:`force_draw<class_RenderingServer_method_force_draw>` to draw a frame even with rendering disabled.
|
||
|
||
Method Descriptions
|
||
-------------------
|
||
|
||
.. _class_RenderingServer_method_bake_render_uv2:
|
||
|
||
- :ref:`Image[]<class_Image>` **bake_render_uv2** **(** :ref:`RID<class_RID>` base, :ref:`Array<class_Array>` material_overrides, :ref:`Vector2i<class_Vector2i>` image_size **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_create:
|
||
|
||
- :ref:`RID<class_RID>` **camera_create** **(** **)**
|
||
|
||
Creates a camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_effects_create:
|
||
|
||
- :ref:`RID<class_RID>` **camera_effects_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_effects_set_custom_exposure:
|
||
|
||
- void **camera_effects_set_custom_exposure** **(** :ref:`RID<class_RID>` camera_effects, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` exposure **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_effects_set_dof_blur:
|
||
|
||
- void **camera_effects_set_dof_blur** **(** :ref:`RID<class_RID>` camera_effects, :ref:`bool<class_bool>` far_enable, :ref:`float<class_float>` far_distance, :ref:`float<class_float>` far_transition, :ref:`bool<class_bool>` near_enable, :ref:`float<class_float>` near_distance, :ref:`float<class_float>` near_transition, :ref:`float<class_float>` amount **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_effects_set_dof_blur_bokeh_shape:
|
||
|
||
- void **camera_effects_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` shape **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_effects_set_dof_blur_quality:
|
||
|
||
- void **camera_effects_set_dof_blur_quality** **(** :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` quality, :ref:`bool<class_bool>` use_jitter **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_set_camera_effects:
|
||
|
||
- void **camera_set_camera_effects** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` effects **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_set_cull_mask:
|
||
|
||
- void **camera_set_cull_mask** **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)**
|
||
|
||
Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to :ref:`Camera3D.cull_mask<class_Camera3D_property_cull_mask>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_set_environment:
|
||
|
||
- void **camera_set_environment** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)**
|
||
|
||
Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment<class_Camera3D_property_environment>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_set_frustum:
|
||
|
||
- void **camera_set_frustum** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`Vector2<class_Vector2>` offset, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||
|
||
Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_set_orthogonal:
|
||
|
||
- void **camera_set_orthogonal** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||
|
||
Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_set_perspective:
|
||
|
||
- void **camera_set_perspective** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` fovy_degrees, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||
|
||
Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_set_transform:
|
||
|
||
- void **camera_set_transform** **(** :ref:`RID<class_RID>` camera, :ref:`Transform3D<class_Transform3D>` transform **)**
|
||
|
||
Sets :ref:`Transform3D<class_Transform3D>` of camera.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_camera_set_use_vertical_aspect:
|
||
|
||
- void **camera_set_use_vertical_aspect** **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, preserves the horizontal aspect ratio which is equivalent to :ref:`Camera3D.KEEP_WIDTH<class_Camera3D_constant_KEEP_WIDTH>`. If ``false``, preserves the vertical aspect ratio which is equivalent to :ref:`Camera3D.KEEP_HEIGHT<class_Camera3D_constant_KEEP_HEIGHT>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_create:
|
||
|
||
- :ref:`RID<class_RID>` **canvas_create** **(** **)**
|
||
|
||
Creates a canvas and returns the assigned :ref:`RID<class_RID>`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_circle:
|
||
|
||
- void **canvas_item_add_circle** **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_clip_ignore:
|
||
|
||
- void **canvas_item_add_clip_ignore** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_line:
|
||
|
||
- void **canvas_item_add_line** **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=1.0 **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_mesh:
|
||
|
||
- void **canvas_item_add_mesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`RID<class_RID>` texture **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region:
|
||
|
||
- void **canvas_item_add_msdf_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`int<class_int>` outline_size=0, :ref:`float<class_float>` px_range=1.0 **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_multimesh:
|
||
|
||
- void **canvas_item_add_multimesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_nine_patch:
|
||
|
||
- void **canvas_item_add_nine_patch** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` source, :ref:`RID<class_RID>` texture, :ref:`Vector2<class_Vector2>` topleft, :ref:`Vector2<class_Vector2>` bottomright, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` x_axis_mode=0, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1) **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_particles:
|
||
|
||
- void **canvas_item_add_particles** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_polygon:
|
||
|
||
- void **canvas_item_add_polygon** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`RID<class_RID>` texture **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_polyline:
|
||
|
||
- void **canvas_item_add_polyline** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_primitive:
|
||
|
||
- void **canvas_item_add_primitive** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs, :ref:`RID<class_RID>` texture, :ref:`float<class_float>` width=1.0 **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_rect:
|
||
|
||
- void **canvas_item_add_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_set_transform:
|
||
|
||
- void **canvas_item_add_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_texture_rect:
|
||
|
||
- void **canvas_item_add_texture_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_texture_rect_region:
|
||
|
||
- void **canvas_item_add_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false, :ref:`bool<class_bool>` clip_uv=true **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_add_triangle_array:
|
||
|
||
- void **canvas_item_add_triangle_array** **(** :ref:`RID<class_RID>` item, :ref:`PackedInt32Array<class_PackedInt32Array>` indices, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`PackedInt32Array<class_PackedInt32Array>` bones=PackedInt32Array(), :ref:`PackedFloat32Array<class_PackedFloat32Array>` weights=PackedFloat32Array(), :ref:`RID<class_RID>` texture, :ref:`int<class_int>` count=-1 **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_clear:
|
||
|
||
- void **canvas_item_clear** **(** :ref:`RID<class_RID>` item **)**
|
||
|
||
Clears the :ref:`CanvasItem<class_CanvasItem>` and removes all commands in it.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_create:
|
||
|
||
- :ref:`RID<class_RID>` **canvas_item_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_canvas_group_mode:
|
||
|
||
- void **canvas_item_set_canvas_group_mode** **(** :ref:`RID<class_RID>` item, :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` mode, :ref:`float<class_float>` clear_margin=5.0, :ref:`bool<class_bool>` fit_empty=false, :ref:`float<class_float>` fit_margin=0.0, :ref:`bool<class_bool>` blur_mipmaps=false **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_clip:
|
||
|
||
- void **canvas_item_set_clip** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer:
|
||
|
||
- void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)**
|
||
|
||
Sets the :ref:`CanvasItem<class_CanvasItem>` to copy a rect to the backbuffer.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_custom_rect:
|
||
|
||
- void **canvas_item_set_custom_rect** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_default_texture_filter:
|
||
|
||
- void **canvas_item_set_default_texture_filter** **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_default_texture_repeat:
|
||
|
||
- void **canvas_item_set_default_texture_repeat** **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_distance_field_mode:
|
||
|
||
- void **canvas_item_set_distance_field_mode** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_draw_behind_parent:
|
||
|
||
- void **canvas_item_set_draw_behind_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_draw_index:
|
||
|
||
- void **canvas_item_set_draw_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)**
|
||
|
||
Sets the index for the :ref:`CanvasItem<class_CanvasItem>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_light_mask:
|
||
|
||
- void **canvas_item_set_light_mask** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_material:
|
||
|
||
- void **canvas_item_set_material** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)**
|
||
|
||
Sets a new material to the :ref:`CanvasItem<class_CanvasItem>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_modulate:
|
||
|
||
- void **canvas_item_set_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_parent:
|
||
|
||
- void **canvas_item_set_parent** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_self_modulate:
|
||
|
||
- void **canvas_item_set_self_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_sort_children_by_y:
|
||
|
||
- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_transform:
|
||
|
||
- void **canvas_item_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_use_parent_material:
|
||
|
||
- void **canvas_item_set_use_parent_material** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
Sets if the :ref:`CanvasItem<class_CanvasItem>` uses its parent's material.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_visibility_notifier:
|
||
|
||
- void **canvas_item_set_visibility_notifier** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enable, :ref:`Rect2<class_Rect2>` area, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_visible:
|
||
|
||
- void **canvas_item_set_visible** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent:
|
||
|
||
- void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
If this is enabled, the Z index of the parent will be added to the children's Z index.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_item_set_z_index:
|
||
|
||
- void **canvas_item_set_z_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)**
|
||
|
||
Sets the :ref:`CanvasItem<class_CanvasItem>`'s Z index, i.e. its draw order (lower indexes are drawn first).
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_attach_to_canvas:
|
||
|
||
- void **canvas_light_attach_to_canvas** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)**
|
||
|
||
Attaches the canvas light to the canvas. Removes it from its previous canvas.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_create:
|
||
|
||
- :ref:`RID<class_RID>` **canvas_light_create** **(** **)**
|
||
|
||
Creates a canvas light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas:
|
||
|
||
- void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)**
|
||
|
||
Attaches a light occluder to the canvas. Removes it from its previous canvas.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_occluder_create:
|
||
|
||
- :ref:`RID<class_RID>` **canvas_light_occluder_create** **(** **)**
|
||
|
||
Creates a light occluder and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_ocluder_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision:
|
||
|
||
- void **canvas_light_occluder_set_as_sdf_collision** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_occluder_set_enabled:
|
||
|
||
- void **canvas_light_occluder_set_enabled** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
Enables or disables light occluder.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_occluder_set_light_mask:
|
||
|
||
- void **canvas_light_occluder_set_light_mask** **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)**
|
||
|
||
The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_occluder_set_polygon:
|
||
|
||
- void **canvas_light_occluder_set_polygon** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)**
|
||
|
||
Sets a light occluder's polygon.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_occluder_set_transform:
|
||
|
||
- void **canvas_light_occluder_set_transform** **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||
|
||
Sets a light occluder's :ref:`Transform2D<class_Transform2D>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_color:
|
||
|
||
- void **canvas_light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
|
||
|
||
Sets the color for a light.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_enabled:
|
||
|
||
- void **canvas_light_set_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
Enables or disables a canvas light.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_energy:
|
||
|
||
- void **canvas_light_set_energy** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)**
|
||
|
||
Sets a canvas light's energy.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_height:
|
||
|
||
- void **canvas_light_set_height** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)**
|
||
|
||
Sets a canvas light's height.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_item_cull_mask:
|
||
|
||
- void **canvas_light_set_item_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
|
||
|
||
The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask:
|
||
|
||
- void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
|
||
|
||
The binary mask used to determine which layers this canvas light's shadows affects. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_layer_range:
|
||
|
||
- void **canvas_light_set_layer_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)**
|
||
|
||
The layer range that gets rendered with this light.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_mode:
|
||
|
||
- void **canvas_light_set_mode** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` mode **)**
|
||
|
||
The mode of the light, see :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` constants.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_shadow_color:
|
||
|
||
- void **canvas_light_set_shadow_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
|
||
|
||
Sets the color of the canvas light's shadow.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_shadow_enabled:
|
||
|
||
- void **canvas_light_set_shadow_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
Enables or disables the canvas light's shadow.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_shadow_filter:
|
||
|
||
- void **canvas_light_set_shadow_filter** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` filter **)**
|
||
|
||
Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` constants.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_shadow_smooth:
|
||
|
||
- void **canvas_light_set_shadow_smooth** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)**
|
||
|
||
Smoothens the shadow. The lower, the smoother.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_texture:
|
||
|
||
- void **canvas_light_set_texture** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
|
||
|
||
Sets the texture to be used by a :ref:`PointLight2D<class_PointLight2D>`. Equivalent to :ref:`PointLight2D.texture<class_PointLight2D_property_texture>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_texture_offset:
|
||
|
||
- void **canvas_light_set_texture_offset** **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)**
|
||
|
||
Sets the offset of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.offset<class_PointLight2D_property_offset>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_texture_scale:
|
||
|
||
- void **canvas_light_set_texture_scale** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)**
|
||
|
||
Sets the scale factor of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.texture_scale<class_PointLight2D_property_texture_scale>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_transform:
|
||
|
||
- void **canvas_light_set_transform** **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||
|
||
Sets the canvas light's :ref:`Transform2D<class_Transform2D>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_light_set_z_range:
|
||
|
||
- void **canvas_light_set_z_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)**
|
||
|
||
Sets the Z range of objects that will be affected by this light. Equivalent to :ref:`Light2D.range_z_min<class_Light2D_property_range_z_min>` and :ref:`Light2D.range_z_max<class_Light2D_property_range_z_max>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_occluder_polygon_create:
|
||
|
||
- :ref:`RID<class_RID>` **canvas_occluder_polygon_create** **(** **)**
|
||
|
||
Creates a new light occluder polygon and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_occluder_polygon_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode:
|
||
|
||
- void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` mode **)**
|
||
|
||
Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` constants.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_occluder_polygon_set_shape:
|
||
|
||
- void **canvas_occluder_polygon_set_shape** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PackedVector2Array<class_PackedVector2Array>` shape, :ref:`bool<class_bool>` closed **)**
|
||
|
||
Sets the shape of the occluder polygon.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_set_disable_scale:
|
||
|
||
- void **canvas_set_disable_scale** **(** :ref:`bool<class_bool>` disable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_set_item_mirroring:
|
||
|
||
- void **canvas_set_item_mirroring** **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)**
|
||
|
||
A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2<class_Vector2>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_set_modulate:
|
||
|
||
- void **canvas_set_modulate** **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)**
|
||
|
||
Modulates all colors in the given canvas.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_set_shadow_texture_size:
|
||
|
||
- void **canvas_set_shadow_texture_size** **(** :ref:`int<class_int>` size **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_texture_create:
|
||
|
||
- :ref:`RID<class_RID>` **canvas_texture_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_texture_set_channel:
|
||
|
||
- void **canvas_texture_set_channel** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` channel, :ref:`RID<class_RID>` texture **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_texture_set_shading_parameters:
|
||
|
||
- void **canvas_texture_set_shading_parameters** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`Color<class_Color>` base_color, :ref:`float<class_float>` shininess **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_texture_set_texture_filter:
|
||
|
||
- void **canvas_texture_set_texture_filter** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_canvas_texture_set_texture_repeat:
|
||
|
||
- void **canvas_texture_set_texture_repeat** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_create_local_rendering_device:
|
||
|
||
- :ref:`RenderingDevice<class_RenderingDevice>` **create_local_rendering_device** **(** **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_create:
|
||
|
||
- :ref:`RID<class_RID>` **decal_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_albedo_mix:
|
||
|
||
- void **decal_set_albedo_mix** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_cull_mask:
|
||
|
||
- void **decal_set_cull_mask** **(** :ref:`RID<class_RID>` decal, :ref:`int<class_int>` mask **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_distance_fade:
|
||
|
||
- void **decal_set_distance_fade** **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` length **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_emission_energy:
|
||
|
||
- void **decal_set_emission_energy** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` energy **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_extents:
|
||
|
||
- void **decal_set_extents** **(** :ref:`RID<class_RID>` decal, :ref:`Vector3<class_Vector3>` extents **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_fade:
|
||
|
||
- void **decal_set_fade** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` above, :ref:`float<class_float>` below **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_modulate:
|
||
|
||
- void **decal_set_modulate** **(** :ref:`RID<class_RID>` decal, :ref:`Color<class_Color>` color **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_normal_fade:
|
||
|
||
- void **decal_set_normal_fade** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` fade **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decal_set_texture:
|
||
|
||
- void **decal_set_texture** **(** :ref:`RID<class_RID>` decal, :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` type, :ref:`RID<class_RID>` texture **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_decals_set_filter:
|
||
|
||
- void **decals_set_filter** **(** :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` filter **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_directional_light_create:
|
||
|
||
- :ref:`RID<class_RID>` **directional_light_create** **(** **)**
|
||
|
||
Creates a directional light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
To place in a scene, attach this directional light to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_directional_shadow_atlas_set_size:
|
||
|
||
- void **directional_shadow_atlas_set_size** **(** :ref:`int<class_int>` size, :ref:`bool<class_bool>` is_16bits **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_directional_shadow_quality_set:
|
||
|
||
- void **directional_shadow_quality_set** **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_bake_panorama:
|
||
|
||
- :ref:`Image<class_Image>` **environment_bake_panorama** **(** :ref:`RID<class_RID>` environment, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_create:
|
||
|
||
- :ref:`RID<class_RID>` **environment_create** **(** **)**
|
||
|
||
Creates an environment and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``environment_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale:
|
||
|
||
- void **environment_glow_set_use_bicubic_upscale** **(** :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_glow_set_use_high_quality:
|
||
|
||
- void **environment_glow_set_use_high_quality** **(** :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_adjustment:
|
||
|
||
- void **environment_set_adjustment** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation, :ref:`bool<class_bool>` use_1d_color_correction, :ref:`RID<class_RID>` color_correction **)**
|
||
|
||
Sets the values to be used with the "Adjustment" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_ambient_light:
|
||
|
||
- void **environment_set_ambient_light** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color, :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` ambient=0, :ref:`float<class_float>` energy=1.0, :ref:`float<class_float>` sky_contibution=0.0, :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` reflection_source=0 **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_background:
|
||
|
||
- void **environment_set_background** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` bg **)**
|
||
|
||
Sets the *BGMode* of the environment. Equivalent to :ref:`Environment.background_mode<class_Environment_property_background_mode>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_bg_color:
|
||
|
||
- void **environment_set_bg_color** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)**
|
||
|
||
Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_bg_energy:
|
||
|
||
- void **environment_set_bg_energy** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` energy **)**
|
||
|
||
Sets the intensity of the background color.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_canvas_max_layer:
|
||
|
||
- void **environment_set_canvas_max_layer** **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)**
|
||
|
||
Sets the maximum layer to use if using Canvas background mode.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_fog:
|
||
|
||
- void **environment_set_fog** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`Color<class_Color>` light_color, :ref:`float<class_float>` light_energy, :ref:`float<class_float>` sun_scatter, :ref:`float<class_float>` density, :ref:`float<class_float>` height, :ref:`float<class_float>` height_density, :ref:`float<class_float>` aerial_perspective **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_glow:
|
||
|
||
- void **environment_set_glow** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`PackedFloat32Array<class_PackedFloat32Array>` levels, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` mix, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`float<class_float>` hdr_luminance_cap, :ref:`float<class_float>` glow_map_strength, :ref:`RID<class_RID>` glow_map **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_sdfgi:
|
||
|
||
- void **environment_set_sdfgi** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` cascades, :ref:`float<class_float>` min_cell_size, :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` y_scale, :ref:`bool<class_bool>` use_occlusion, :ref:`float<class_float>` bounce_feedback, :ref:`bool<class_bool>` read_sky, :ref:`float<class_float>` energy, :ref:`float<class_float>` normal_bias, :ref:`float<class_float>` probe_bias **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge:
|
||
|
||
- void **environment_set_sdfgi_frames_to_converge** **(** :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` frames **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light:
|
||
|
||
- void **environment_set_sdfgi_frames_to_update_light** **(** :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` frames **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_sdfgi_ray_count:
|
||
|
||
- void **environment_set_sdfgi_ray_count** **(** :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` ray_count **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_sky:
|
||
|
||
- void **environment_set_sky** **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)**
|
||
|
||
Sets the :ref:`Sky<class_Sky>` to be used as the environment's background when using *BGMode* sky. Equivalent to :ref:`Environment.sky<class_Environment_property_sky>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_sky_custom_fov:
|
||
|
||
- void **environment_set_sky_custom_fov** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)**
|
||
|
||
Sets a custom field of view for the background :ref:`Sky<class_Sky>`. Equivalent to :ref:`Environment.sky_custom_fov<class_Environment_property_sky_custom_fov>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_sky_orientation:
|
||
|
||
- void **environment_set_sky_orientation** **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)**
|
||
|
||
Sets the rotation of the background :ref:`Sky<class_Sky>` expressed as a :ref:`Basis<class_Basis>`. Equivalent to :ref:`Environment.sky_rotation<class_Environment_property_sky_rotation>`, where the rotation vector is used to construct the :ref:`Basis<class_Basis>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_ssao:
|
||
|
||
- void **environment_set_ssao** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` radius, :ref:`float<class_float>` intensity, :ref:`float<class_float>` power, :ref:`float<class_float>` detail, :ref:`float<class_float>` horizon, :ref:`float<class_float>` sharpness, :ref:`float<class_float>` light_affect, :ref:`float<class_float>` ao_channel_affect **)**
|
||
|
||
Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_ssao_quality:
|
||
|
||
- void **environment_set_ssao_quality** **(** :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)**
|
||
|
||
Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_ssil_quality:
|
||
|
||
- void **environment_set_ssil_quality** **(** :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)**
|
||
|
||
Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_ssr:
|
||
|
||
- void **environment_set_ssr** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` max_steps, :ref:`float<class_float>` fade_in, :ref:`float<class_float>` fade_out, :ref:`float<class_float>` depth_tolerance **)**
|
||
|
||
Sets the variables to be used with the "screen space reflections" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_ssr_roughness_quality:
|
||
|
||
- void **environment_set_ssr_roughness_quality** **(** :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` quality **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_tonemap:
|
||
|
||
- void **environment_set_tonemap** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` tone_mapper, :ref:`float<class_float>` exposure, :ref:`float<class_float>` white, :ref:`bool<class_bool>` auto_exposure, :ref:`float<class_float>` min_luminance, :ref:`float<class_float>` max_luminance, :ref:`float<class_float>` auto_exp_speed, :ref:`float<class_float>` auto_exp_grey **)**
|
||
|
||
Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment<class_Environment>` for more details.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_volumetric_fog:
|
||
|
||
- void **environment_set_volumetric_fog** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` density, :ref:`Color<class_Color>` albedo, :ref:`Color<class_Color>` emission, :ref:`float<class_float>` emission_energy, :ref:`float<class_float>` anisotropy, :ref:`float<class_float>` length, :ref:`float<class_float>` p_detail_spread, :ref:`float<class_float>` gi_inject, :ref:`bool<class_bool>` temporal_reprojection, :ref:`float<class_float>` temporal_reprojection_amount, :ref:`float<class_float>` ambient_inject **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active:
|
||
|
||
- void **environment_set_volumetric_fog_filter_active** **(** :ref:`bool<class_bool>` active **)**
|
||
|
||
Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size:
|
||
|
||
- void **environment_set_volumetric_fog_volume_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` depth **)**
|
||
|
||
Sets the resolution of the volumetric fog's froxel buffer. ``size`` is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While ``depth`` is directly used to set the depth of the buffer.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_fog_volume_create:
|
||
|
||
- :ref:`RID<class_RID>` **fog_volume_create** **(** **)**
|
||
|
||
Creates a new fog volume and allocates an RID.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_fog_volume_set_extents:
|
||
|
||
- void **fog_volume_set_extents** **(** :ref:`RID<class_RID>` fog_volume, :ref:`Vector3<class_Vector3>` extents **)**
|
||
|
||
Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>` or :ref:`FOG_VOLUME_SHAPE_BOX<class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_fog_volume_set_material:
|
||
|
||
- void **fog_volume_set_material** **(** :ref:`RID<class_RID>` fog_volume, :ref:`RID<class_RID>` material **)**
|
||
|
||
Sets the :ref:`Material<class_Material>` of the fog volume. Can be either a :ref:`FogMaterial<class_FogMaterial>` or a custom :ref:`ShaderMaterial<class_ShaderMaterial>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_fog_volume_set_shape:
|
||
|
||
- void **fog_volume_set_shape** **(** :ref:`RID<class_RID>` fog_volume, :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` shape **)**
|
||
|
||
Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>`, :ref:`FOG_VOLUME_SHAPE_BOX<class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX>`, or :ref:`FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>` or :ref:`FOG_VOLUME_SHAPE_WORLD<class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_force_draw:
|
||
|
||
- void **force_draw** **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_force_sync:
|
||
|
||
- void **force_sync** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_free_rid:
|
||
|
||
- void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
|
||
|
||
Tries to free an object in the RenderingServer.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_frame_setup_time_cpu:
|
||
|
||
- :ref:`float<class_float>` **get_frame_setup_time_cpu** **(** **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_rendering_device:
|
||
|
||
- :ref:`RenderingDevice<class_RenderingDevice>` **get_rendering_device** **(** **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_rendering_info:
|
||
|
||
- :ref:`int<class_int>` **get_rendering_info** **(** :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` info **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_test_cube:
|
||
|
||
- :ref:`RID<class_RID>` **get_test_cube** **(** **)**
|
||
|
||
Returns the id of the test cube. Creates one if none exists.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_test_texture:
|
||
|
||
- :ref:`RID<class_RID>` **get_test_texture** **(** **)**
|
||
|
||
Returns the id of the test texture. Creates one if none exists.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_video_adapter_name:
|
||
|
||
- :ref:`String<class_String>` **get_video_adapter_name** **(** **)** |const|
|
||
|
||
Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
|
||
|
||
\ **Note:** When running a headless or server binary, this function returns an empty string.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_video_adapter_type:
|
||
|
||
- :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **get_video_adapter_type** **(** **)** |const|
|
||
|
||
Returns the type of the video adapter. Since dedicated graphics cards from a given generation will *usually* be significantly faster than integrated graphics made in the same generation, the device type can be used as a basis for automatic graphics settings adjustment. However, this is not always true, so make sure to provide users with a way to manually override graphics settings.
|
||
|
||
\ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns :ref:`RenderingDevice.DEVICE_TYPE_OTHER<class_RenderingDevice_constant_DEVICE_TYPE_OTHER>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_video_adapter_vendor:
|
||
|
||
- :ref:`String<class_String>` **get_video_adapter_vendor** **(** **)** |const|
|
||
|
||
Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
|
||
|
||
\ **Note:** When running a headless or server binary, this function returns an empty string.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_get_white_texture:
|
||
|
||
- :ref:`RID<class_RID>` **get_white_texture** **(** **)**
|
||
|
||
Returns the id of a white texture. Creates one if none exists.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_gi_set_use_half_resolution:
|
||
|
||
- void **gi_set_use_half_resolution** **(** :ref:`bool<class_bool>` half_resolution **)**
|
||
|
||
If ``half_resolution`` is ``true``, renders :ref:`VoxelGI<class_VoxelGI>` and SDFGI (:ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>`) buffers at halved resolution (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. :ref:`LightmapGI<class_LightmapGI>` rendering is not affected by this setting. See also :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution<class_ProjectSettings_property_rendering/global_illumination/gi/use_half_resolution>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_global_variable_add:
|
||
|
||
- void **global_variable_add** **(** :ref:`StringName<class_StringName>` name, :ref:`GlobalVariableType<enum_RenderingServer_GlobalVariableType>` type, :ref:`Variant<class_Variant>` default_value **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_global_variable_get:
|
||
|
||
- :ref:`Variant<class_Variant>` **global_variable_get** **(** :ref:`StringName<class_StringName>` name **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_global_variable_get_list:
|
||
|
||
- :ref:`PackedStringArray<class_PackedStringArray>` **global_variable_get_list** **(** **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_global_variable_get_type:
|
||
|
||
- :ref:`GlobalVariableType<enum_RenderingServer_GlobalVariableType>` **global_variable_get_type** **(** :ref:`StringName<class_StringName>` name **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_global_variable_remove:
|
||
|
||
- void **global_variable_remove** **(** :ref:`StringName<class_StringName>` name **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_global_variable_set:
|
||
|
||
- void **global_variable_set** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_global_variable_set_override:
|
||
|
||
- void **global_variable_set_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_has_changed:
|
||
|
||
- :ref:`bool<class_bool>` **has_changed** **(** **)** |const|
|
||
|
||
Returns ``true`` if changes have been made to the RenderingServer's data. :ref:`force_draw<class_RenderingServer_method_force_draw>` is usually called if this happens.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_has_feature:
|
||
|
||
- :ref:`bool<class_bool>` **has_feature** **(** :ref:`Features<enum_RenderingServer_Features>` feature **)** |const|
|
||
|
||
Not yet implemented. Always returns ``false``.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_has_os_feature:
|
||
|
||
- :ref:`bool<class_bool>` **has_os_feature** **(** :ref:`String<class_String>` feature **)** |const|
|
||
|
||
Returns ``true`` if the OS supports a certain feature. Features might be ``s3tc``, ``etc``, and ``etc2``.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_attach_object_instance_id:
|
||
|
||
- void **instance_attach_object_instance_id** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)**
|
||
|
||
Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>`, :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>`, and :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_attach_skeleton:
|
||
|
||
- void **instance_attach_skeleton** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)**
|
||
|
||
Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_create:
|
||
|
||
- :ref:`RID<class_RID>` **instance_create** **(** **)**
|
||
|
||
Creates a visual instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
An instance is a way of placing a 3D object in the scenario. Objects like particles, meshes, and reflection probes need to be associated with an instance to be visible in the scenario using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_create2:
|
||
|
||
- :ref:`RID<class_RID>` **instance_create2** **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)**
|
||
|
||
Creates a visual instance, adds it to the RenderingServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_get_shader_parameter:
|
||
|
||
- :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value:
|
||
|
||
- :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter_default_value** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list:
|
||
|
||
- :ref:`Array<class_Array>` **instance_geometry_get_shader_parameter_list** **(** :ref:`RID<class_RID>` instance **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting:
|
||
|
||
- void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` shadow_casting_setting **)**
|
||
|
||
Sets the shadow casting setting to one of :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`. Equivalent to :ref:`GeometryInstance3D.cast_shadow<class_GeometryInstance3D_property_cast_shadow>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_flag:
|
||
|
||
- void **instance_geometry_set_flag** **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
Sets the flag for a given :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`. See :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` for more details.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_lightmap:
|
||
|
||
- void **instance_geometry_set_lightmap** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` lightmap, :ref:`Rect2<class_Rect2>` lightmap_uv_scale, :ref:`int<class_int>` lightmap_slice **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_lod_bias:
|
||
|
||
- void **instance_geometry_set_lod_bias** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` lod_bias **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_material_overlay:
|
||
|
||
- void **instance_geometry_set_material_overlay** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
|
||
|
||
Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to :ref:`GeometryInstance3D.material_overlay<class_GeometryInstance3D_property_material_overlay>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_material_override:
|
||
|
||
- void **instance_geometry_set_material_override** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
|
||
|
||
Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to :ref:`GeometryInstance3D.material_override<class_GeometryInstance3D_property_material_override>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_shader_parameter:
|
||
|
||
- void **instance_geometry_set_shader_parameter** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_transparency:
|
||
|
||
- void **instance_geometry_set_transparency** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` transparency **)**
|
||
|
||
Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency<class_GeometryInstance3D_property_transparency>`.
|
||
|
||
A transparency of ``0.0`` is fully opaque, while ``1.0`` is fully transparent. Values greater than ``0.0`` (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting ``transparency`` to a value greater than ``0.0`` (exclusive) will *not* disable shadow rendering.
|
||
|
||
In spatial shaders, ``1.0 - transparency`` is set as the default value of the ``ALPHA`` built-in.
|
||
|
||
\ **Note:** ``transparency`` is clamped between ``0.0`` and ``1.0``, so this property cannot be used to make transparent materials more opaque than they originally are.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_geometry_set_visibility_range:
|
||
|
||
- void **instance_geometry_set_visibility_range** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` min_margin, :ref:`float<class_float>` max_margin, :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` fade_mode **)**
|
||
|
||
Sets the visibility range values for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.visibility_range_begin<class_GeometryInstance3D_property_visibility_range_begin>` and related properties.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_base:
|
||
|
||
- void **instance_set_base** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)**
|
||
|
||
Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_blend_shape_weight:
|
||
|
||
- void **instance_set_blend_shape_weight** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)**
|
||
|
||
Sets the weight for a given blend shape associated with this instance.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_custom_aabb:
|
||
|
||
- void **instance_set_custom_aabb** **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)**
|
||
|
||
Sets a custom AABB to use when culling objects from the view frustum. Equivalent to :ref:`GeometryInstance3D.set_custom_aabb<class_GeometryInstance3D_method_set_custom_aabb>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_extra_visibility_margin:
|
||
|
||
- void **instance_set_extra_visibility_margin** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)**
|
||
|
||
Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to :ref:`GeometryInstance3D.extra_cull_margin<class_GeometryInstance3D_property_extra_cull_margin>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_ignore_culling:
|
||
|
||
- void **instance_set_ignore_culling** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_layer_mask:
|
||
|
||
- void **instance_set_layer_mask** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)**
|
||
|
||
Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_scenario:
|
||
|
||
- void **instance_set_scenario** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)**
|
||
|
||
Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_surface_override_material:
|
||
|
||
- void **instance_set_surface_override_material** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
|
||
|
||
Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material<class_MeshInstance3D_method_set_surface_override_material>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_transform:
|
||
|
||
- void **instance_set_transform** **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)**
|
||
|
||
Sets the world space transform of the instance. Equivalent to :ref:`Node3D.transform<class_Node3D_property_transform>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_visibility_parent:
|
||
|
||
- void **instance_set_visibility_parent** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` parent **)**
|
||
|
||
Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent<class_Node3D_property_visibility_parent>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instance_set_visible:
|
||
|
||
- void **instance_set_visible** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)**
|
||
|
||
Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible<class_Node3D_property_visible>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instances_cull_aabb:
|
||
|
||
- :ref:`Array<class_Array>` **instances_cull_aabb** **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario **)** |const|
|
||
|
||
Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as :ref:`MeshInstance3D<class_MeshInstance3D>` or :ref:`DirectionalLight3D<class_DirectionalLight3D>`. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D<class_World3D>` you want to query. This forces an update for all resources queued to update.
|
||
|
||
\ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instances_cull_convex:
|
||
|
||
- :ref:`Array<class_Array>` **instances_cull_convex** **(** :ref:`Array<class_Array>` convex, :ref:`RID<class_RID>` scenario **)** |const|
|
||
|
||
Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as :ref:`MeshInstance3D<class_MeshInstance3D>` or :ref:`DirectionalLight3D<class_DirectionalLight3D>`. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D<class_World3D>` you want to query. This forces an update for all resources queued to update.
|
||
|
||
\ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_instances_cull_ray:
|
||
|
||
- :ref:`Array<class_Array>` **instances_cull_ray** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario **)** |const|
|
||
|
||
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as :ref:`MeshInstance3D<class_MeshInstance3D>` or :ref:`DirectionalLight3D<class_DirectionalLight3D>`. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D<class_World3D>` you want to query. This forces an update for all resources queued to update.
|
||
|
||
\ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_directional_set_blend_splits:
|
||
|
||
- void **light_directional_set_blend_splits** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to :ref:`DirectionalLight3D.directional_shadow_blend_splits<class_DirectionalLight3D_property_directional_shadow_blend_splits>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_directional_set_shadow_mode:
|
||
|
||
- void **light_directional_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` mode **)**
|
||
|
||
Sets the shadow mode for this directional light. Equivalent to :ref:`DirectionalLight3D.directional_shadow_mode<class_DirectionalLight3D_property_directional_shadow_mode>`. See :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` for options.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_directional_set_sky_only:
|
||
|
||
- void **light_directional_set_sky_only** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, this light will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_omni_set_shadow_mode:
|
||
|
||
- void **light_omni_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` mode **)**
|
||
|
||
Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to :ref:`OmniLight3D.omni_shadow_mode<class_OmniLight3D_property_omni_shadow_mode>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_projectors_set_filter:
|
||
|
||
- void **light_projectors_set_filter** **(** :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` filter **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_bake_mode:
|
||
|
||
- void **light_set_bake_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` bake_mode **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_color:
|
||
|
||
- void **light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
|
||
|
||
Sets the color of the light. Equivalent to :ref:`Light3D.light_color<class_Light3D_property_light_color>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_cull_mask:
|
||
|
||
- void **light_set_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
|
||
|
||
Sets the cull mask for this Light3D. Lights only affect objects in the selected layers. Equivalent to :ref:`Light3D.light_cull_mask<class_Light3D_property_light_cull_mask>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_max_sdfgi_cascade:
|
||
|
||
- void **light_set_max_sdfgi_cascade** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` cascade **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_negative:
|
||
|
||
- void **light_set_negative** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative<class_Light3D_property_light_negative>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_param:
|
||
|
||
- void **light_set_param** **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_RenderingServer_LightParam>` param, :ref:`float<class_float>` value **)**
|
||
|
||
Sets the specified light parameter. See :ref:`LightParam<enum_RenderingServer_LightParam>` for options. Equivalent to :ref:`Light3D.set_param<class_Light3D_method_set_param>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_projector:
|
||
|
||
- void **light_set_projector** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
|
||
|
||
Not implemented in Godot 3.x.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_reverse_cull_face_mode:
|
||
|
||
- void **light_set_reverse_cull_face_mode** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
If ``true``, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with :ref:`instance_geometry_set_cast_shadows_setting<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>`. Equivalent to :ref:`Light3D.shadow_reverse_cull_face<class_Light3D_property_shadow_reverse_cull_face>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_shadow:
|
||
|
||
- void **light_set_shadow** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled<class_Light3D_property_shadow_enabled>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_light_set_shadow_color:
|
||
|
||
- void **light_set_shadow_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
|
||
|
||
Sets the color of the shadow cast by the light. Equivalent to :ref:`Light3D.shadow_color<class_Light3D_property_shadow_color>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_create:
|
||
|
||
- :ref:`RID<class_RID>` **lightmap_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree:
|
||
|
||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_bsp_tree** **(** :ref:`RID<class_RID>` lightmap **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_get_probe_capture_points:
|
||
|
||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **lightmap_get_probe_capture_points** **(** :ref:`RID<class_RID>` lightmap **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_get_probe_capture_sh:
|
||
|
||
- :ref:`PackedColorArray<class_PackedColorArray>` **lightmap_get_probe_capture_sh** **(** :ref:`RID<class_RID>` lightmap **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra:
|
||
|
||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_tetrahedra** **(** :ref:`RID<class_RID>` lightmap **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_set_probe_bounds:
|
||
|
||
- void **lightmap_set_probe_bounds** **(** :ref:`RID<class_RID>` lightmap, :ref:`AABB<class_AABB>` bounds **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_set_probe_capture_data:
|
||
|
||
- void **lightmap_set_probe_capture_data** **(** :ref:`RID<class_RID>` lightmap, :ref:`PackedVector3Array<class_PackedVector3Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` point_sh, :ref:`PackedInt32Array<class_PackedInt32Array>` tetrahedra, :ref:`PackedInt32Array<class_PackedInt32Array>` bsp_tree **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed:
|
||
|
||
- void **lightmap_set_probe_capture_update_speed** **(** :ref:`float<class_float>` speed **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_set_probe_interior:
|
||
|
||
- void **lightmap_set_probe_interior** **(** :ref:`RID<class_RID>` lightmap, :ref:`bool<class_bool>` interior **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_lightmap_set_textures:
|
||
|
||
- void **lightmap_set_textures** **(** :ref:`RID<class_RID>` lightmap, :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` uses_sh **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_make_sphere_mesh:
|
||
|
||
- :ref:`RID<class_RID>` **make_sphere_mesh** **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)**
|
||
|
||
Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_material_create:
|
||
|
||
- :ref:`RID<class_RID>` **material_create** **(** **)**
|
||
|
||
Creates an empty material and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``material_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_material_get_param:
|
||
|
||
- :ref:`Variant<class_Variant>` **material_get_param** **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter **)** |const|
|
||
|
||
Returns the value of a certain material's parameter.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_material_set_next_pass:
|
||
|
||
- void **material_set_next_pass** **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)**
|
||
|
||
Sets an object's next material.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_material_set_param:
|
||
|
||
- void **material_set_param** **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)**
|
||
|
||
Sets a material's parameter.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_material_set_render_priority:
|
||
|
||
- void **material_set_render_priority** **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)**
|
||
|
||
Sets a material's render priority.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_material_set_shader:
|
||
|
||
- void **material_set_shader** **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)**
|
||
|
||
Sets a shader material's shader.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_add_surface:
|
||
|
||
- void **mesh_add_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`Dictionary<class_Dictionary>` surface **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_add_surface_from_arrays:
|
||
|
||
- void **mesh_add_surface_from_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[], :ref:`Dictionary<class_Dictionary>` lods={}, :ref:`int<class_int>` compress_format=0 **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_clear:
|
||
|
||
- void **mesh_clear** **(** :ref:`RID<class_RID>` mesh **)**
|
||
|
||
Removes all surfaces from a mesh.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_create:
|
||
|
||
- :ref:`RID<class_RID>` **mesh_create** **(** **)**
|
||
|
||
Creates a new mesh and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``mesh_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
To place in a scene, attach this mesh to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_create_from_surfaces:
|
||
|
||
- :ref:`RID<class_RID>` **mesh_create_from_surfaces** **(** :ref:`Dictionary[]<class_Dictionary>` surfaces, :ref:`int<class_int>` blend_shape_count=0 **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_get_blend_shape_count:
|
||
|
||
- :ref:`int<class_int>` **mesh_get_blend_shape_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
|
||
|
||
Returns a mesh's blend shape count.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_get_blend_shape_mode:
|
||
|
||
- :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **mesh_get_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh **)** |const|
|
||
|
||
Returns a mesh's blend shape mode.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_get_custom_aabb:
|
||
|
||
- :ref:`AABB<class_AABB>` **mesh_get_custom_aabb** **(** :ref:`RID<class_RID>` mesh **)** |const|
|
||
|
||
Returns a mesh's custom aabb.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_get_surface:
|
||
|
||
- :ref:`Dictionary<class_Dictionary>` **mesh_get_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_get_surface_count:
|
||
|
||
- :ref:`int<class_int>` **mesh_get_surface_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
|
||
|
||
Returns a mesh's number of surfaces.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_set_blend_shape_mode:
|
||
|
||
- void **mesh_set_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` mode **)**
|
||
|
||
Sets a mesh's blend shape mode.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_set_custom_aabb:
|
||
|
||
- void **mesh_set_custom_aabb** **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)**
|
||
|
||
Sets a mesh's custom aabb.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_set_shadow_mesh:
|
||
|
||
- void **mesh_set_shadow_mesh** **(** :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` shadow_mesh **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_get_arrays:
|
||
|
||
- :ref:`Array<class_Array>` **mesh_surface_get_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
||
|
||
Returns a mesh's surface's buffer arrays.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays:
|
||
|
||
- :ref:`Array<class_Array>` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
||
|
||
Returns a mesh's surface's arrays for blend shapes.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride:
|
||
|
||
- :ref:`int<class_int>` **mesh_surface_get_format_attribute_stride** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_count **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_get_format_offset:
|
||
|
||
- :ref:`int<class_int>` **mesh_surface_get_format_offset** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_count, :ref:`int<class_int>` array_index **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_get_format_skin_stride:
|
||
|
||
- :ref:`int<class_int>` **mesh_surface_get_format_skin_stride** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_count **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride:
|
||
|
||
- :ref:`int<class_int>` **mesh_surface_get_format_vertex_stride** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` vertex_count **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_get_material:
|
||
|
||
- :ref:`RID<class_RID>` **mesh_surface_get_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
|
||
|
||
Returns a mesh's surface's material.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_set_material:
|
||
|
||
- void **mesh_surface_set_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
|
||
|
||
Sets a mesh's surface's material.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_update_attribute_region:
|
||
|
||
- void **mesh_surface_update_attribute_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_update_skin_region:
|
||
|
||
- void **mesh_surface_update_skin_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_mesh_surface_update_vertex_region:
|
||
|
||
- void **mesh_surface_update_vertex_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_allocate_data:
|
||
|
||
- void **multimesh_allocate_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` instances, :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` transform_format, :ref:`bool<class_bool>` color_format=false, :ref:`bool<class_bool>` custom_data_format=false **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_create:
|
||
|
||
- :ref:`RID<class_RID>` **multimesh_create** **(** **)**
|
||
|
||
Creates a new multimesh on the RenderingServer and returns an :ref:`RID<class_RID>` handle. This RID will be used in all ``multimesh_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
To place in a scene, attach this multimesh to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_get_aabb:
|
||
|
||
- :ref:`AABB<class_AABB>` **multimesh_get_aabb** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
||
|
||
Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_get_buffer:
|
||
|
||
- :ref:`PackedFloat32Array<class_PackedFloat32Array>` **multimesh_get_buffer** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_get_instance_count:
|
||
|
||
- :ref:`int<class_int>` **multimesh_get_instance_count** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
||
|
||
Returns the number of instances allocated for this multimesh.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_get_mesh:
|
||
|
||
- :ref:`RID<class_RID>` **multimesh_get_mesh** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
||
|
||
Returns the RID of the mesh that will be used in drawing this multimesh.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_get_visible_instances:
|
||
|
||
- :ref:`int<class_int>` **multimesh_get_visible_instances** **(** :ref:`RID<class_RID>` multimesh **)** |const|
|
||
|
||
Returns the number of visible instances for this multimesh.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_instance_get_color:
|
||
|
||
- :ref:`Color<class_Color>` **multimesh_instance_get_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
|
||
|
||
Returns the color by which the specified instance will be modulated.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_instance_get_custom_data:
|
||
|
||
- :ref:`Color<class_Color>` **multimesh_instance_get_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
|
||
|
||
Returns the custom data associated with the specified instance.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_instance_get_transform:
|
||
|
||
- :ref:`Transform3D<class_Transform3D>` **multimesh_instance_get_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
|
||
|
||
Returns the :ref:`Transform3D<class_Transform3D>` of the specified instance.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_instance_get_transform_2d:
|
||
|
||
- :ref:`Transform2D<class_Transform2D>` **multimesh_instance_get_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
|
||
|
||
Returns the :ref:`Transform2D<class_Transform2D>` of the specified instance. For use when the multimesh is set to use 2D transforms.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_instance_set_color:
|
||
|
||
- void **multimesh_instance_set_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)**
|
||
|
||
Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color<class_MultiMesh_method_set_instance_color>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_instance_set_custom_data:
|
||
|
||
- void **multimesh_instance_set_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)**
|
||
|
||
Sets the custom data for this instance. Custom data is passed as a :ref:`Color<class_Color>`, but is interpreted as a ``vec4`` in the shader. Equivalent to :ref:`MultiMesh.set_instance_custom_data<class_MultiMesh_method_set_instance_custom_data>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_instance_set_transform:
|
||
|
||
- void **multimesh_instance_set_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform3D<class_Transform3D>` transform **)**
|
||
|
||
Sets the :ref:`Transform3D<class_Transform3D>` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform<class_MultiMesh_method_set_instance_transform>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_instance_set_transform_2d:
|
||
|
||
- void **multimesh_instance_set_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||
|
||
Sets the :ref:`Transform2D<class_Transform2D>` for this instance. For use when multimesh is used in 2D. Equivalent to :ref:`MultiMesh.set_instance_transform_2d<class_MultiMesh_method_set_instance_transform_2d>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_set_buffer:
|
||
|
||
- void **multimesh_set_buffer** **(** :ref:`RID<class_RID>` multimesh, :ref:`PackedFloat32Array<class_PackedFloat32Array>` buffer **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_set_mesh:
|
||
|
||
- void **multimesh_set_mesh** **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)**
|
||
|
||
Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh<class_MultiMesh_property_mesh>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_multimesh_set_visible_instances:
|
||
|
||
- void **multimesh_set_visible_instances** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)**
|
||
|
||
Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to :ref:`MultiMesh.visible_instance_count<class_MultiMesh_property_visible_instance_count>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_occluder_create:
|
||
|
||
- :ref:`RID<class_RID>` **occluder_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_occluder_set_mesh:
|
||
|
||
- void **occluder_set_mesh** **(** :ref:`RID<class_RID>` occluder, :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_omni_light_create:
|
||
|
||
- :ref:`RID<class_RID>` **omni_light_create** **(** **)**
|
||
|
||
Creates a new omni light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
To place in a scene, attach this omni light to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_create:
|
||
|
||
- :ref:`RID<class_RID>` **particles_collision_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_height_field_update:
|
||
|
||
- void **particles_collision_height_field_update** **(** :ref:`RID<class_RID>` particles_collision **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_attractor_attenuation:
|
||
|
||
- void **particles_collision_set_attractor_attenuation** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` curve **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_attractor_directionality:
|
||
|
||
- void **particles_collision_set_attractor_directionality** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` amount **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_attractor_strength:
|
||
|
||
- void **particles_collision_set_attractor_strength** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` setrngth **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_box_extents:
|
||
|
||
- void **particles_collision_set_box_extents** **(** :ref:`RID<class_RID>` particles_collision, :ref:`Vector3<class_Vector3>` extents **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_collision_type:
|
||
|
||
- void **particles_collision_set_collision_type** **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` type **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_cull_mask:
|
||
|
||
- void **particles_collision_set_cull_mask** **(** :ref:`RID<class_RID>` particles_collision, :ref:`int<class_int>` mask **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_field_texture:
|
||
|
||
- void **particles_collision_set_field_texture** **(** :ref:`RID<class_RID>` particles_collision, :ref:`RID<class_RID>` texture **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_height_field_resolution:
|
||
|
||
- void **particles_collision_set_height_field_resolution** **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` resolution **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_collision_set_sphere_radius:
|
||
|
||
- void **particles_collision_set_sphere_radius** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` radius **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_create:
|
||
|
||
- :ref:`RID<class_RID>` **particles_create** **(** **)**
|
||
|
||
Creates a particle system and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``particles_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
To place in a scene, attach these particles to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_emit:
|
||
|
||
- void **particles_emit** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` emit_flags **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_get_current_aabb:
|
||
|
||
- :ref:`AABB<class_AABB>` **particles_get_current_aabb** **(** :ref:`RID<class_RID>` particles **)**
|
||
|
||
Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb<class_GPUParticles3D_method_capture_aabb>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_get_emitting:
|
||
|
||
- :ref:`bool<class_bool>` **particles_get_emitting** **(** :ref:`RID<class_RID>` particles **)**
|
||
|
||
Returns ``true`` if particles are currently set to emitting.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_is_inactive:
|
||
|
||
- :ref:`bool<class_bool>` **particles_is_inactive** **(** :ref:`RID<class_RID>` particles **)**
|
||
|
||
Returns ``true`` if particles are not emitting and particles are set to inactive.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_request_process:
|
||
|
||
- void **particles_request_process** **(** :ref:`RID<class_RID>` particles **)**
|
||
|
||
Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>`, :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>`, or :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_restart:
|
||
|
||
- void **particles_restart** **(** :ref:`RID<class_RID>` particles **)**
|
||
|
||
Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart<class_GPUParticles3D_method_restart>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_amount:
|
||
|
||
- void **particles_set_amount** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)**
|
||
|
||
Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_collision_base_size:
|
||
|
||
- void **particles_set_collision_base_size** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` size **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_custom_aabb:
|
||
|
||
- void **particles_set_custom_aabb** **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)**
|
||
|
||
Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_draw_order:
|
||
|
||
- void **particles_set_draw_order** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` order **)**
|
||
|
||
Sets the draw order of the particles to one of the named enums from :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`. See :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` for options. Equivalent to :ref:`GPUParticles3D.draw_order<class_GPUParticles3D_property_draw_order>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_draw_pass_mesh:
|
||
|
||
- void **particles_set_draw_pass_mesh** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)**
|
||
|
||
Sets the mesh to be used for the specified draw pass. Equivalent to :ref:`GPUParticles3D.draw_pass_1<class_GPUParticles3D_property_draw_pass_1>`, :ref:`GPUParticles3D.draw_pass_2<class_GPUParticles3D_property_draw_pass_2>`, :ref:`GPUParticles3D.draw_pass_3<class_GPUParticles3D_property_draw_pass_3>`, and :ref:`GPUParticles3D.draw_pass_4<class_GPUParticles3D_property_draw_pass_4>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_draw_passes:
|
||
|
||
- void **particles_set_draw_passes** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)**
|
||
|
||
Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes<class_GPUParticles3D_property_draw_passes>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_emission_transform:
|
||
|
||
- void **particles_set_emission_transform** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform **)**
|
||
|
||
Sets the :ref:`Transform3D<class_Transform3D>` that will be used by the particles when they first emit.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_emitting:
|
||
|
||
- void **particles_set_emitting** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)**
|
||
|
||
If ``true``, particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to :ref:`GPUParticles3D.emitting<class_GPUParticles3D_property_emitting>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_explosiveness_ratio:
|
||
|
||
- void **particles_set_explosiveness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
|
||
|
||
Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness<class_GPUParticles3D_property_explosiveness>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_fixed_fps:
|
||
|
||
- void **particles_set_fixed_fps** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)**
|
||
|
||
Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps<class_GPUParticles3D_property_fixed_fps>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_fractional_delta:
|
||
|
||
- void **particles_set_fractional_delta** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta<class_GPUParticles3D_property_fract_delta>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_interpolate:
|
||
|
||
- void **particles_set_interpolate** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_lifetime:
|
||
|
||
- void **particles_set_lifetime** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)**
|
||
|
||
Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime<class_GPUParticles3D_property_lifetime>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_mode:
|
||
|
||
- void **particles_set_mode** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` mode **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_one_shot:
|
||
|
||
- void **particles_set_one_shot** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)**
|
||
|
||
If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot<class_GPUParticles3D_property_one_shot>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_pre_process_time:
|
||
|
||
- void **particles_set_pre_process_time** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)**
|
||
|
||
Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to :ref:`GPUParticles3D.preprocess<class_GPUParticles3D_property_preprocess>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_process_material:
|
||
|
||
- void **particles_set_process_material** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)**
|
||
|
||
Sets the material for processing the particles.
|
||
|
||
\ **Note:** This is not the material used to draw the materials. Equivalent to :ref:`GPUParticles3D.process_material<class_GPUParticles3D_property_process_material>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_randomness_ratio:
|
||
|
||
- void **particles_set_randomness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
|
||
|
||
Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness<class_GPUParticles3D_property_randomness>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_speed_scale:
|
||
|
||
- void **particles_set_speed_scale** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)**
|
||
|
||
Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale<class_GPUParticles3D_property_speed_scale>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_subemitter:
|
||
|
||
- void **particles_set_subemitter** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` subemitter_particles **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_trail_bind_poses:
|
||
|
||
- void **particles_set_trail_bind_poses** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D[]<class_Transform3D>` bind_poses **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_trails:
|
||
|
||
- void **particles_set_trails** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` length_sec **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_transform_align:
|
||
|
||
- void **particles_set_transform_align** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` align **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_particles_set_use_local_coordinates:
|
||
|
||
- void **particles_set_use_local_coordinates** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords<class_GPUParticles3D_property_local_coords>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_create:
|
||
|
||
- :ref:`RID<class_RID>` **reflection_probe_create** **(** **)**
|
||
|
||
Creates a reflection probe and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``reflection_probe_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
To place in a scene, attach this reflection probe to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_ambient_color:
|
||
|
||
- void **reflection_probe_set_ambient_color** **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_ambient_energy:
|
||
|
||
- void **reflection_probe_set_ambient_energy** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_ambient_mode:
|
||
|
||
- void **reflection_probe_set_ambient_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` mode **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_as_interior:
|
||
|
||
- void **reflection_probe_set_as_interior** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior<class_ReflectionProbe_property_interior>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_cull_mask:
|
||
|
||
- void **reflection_probe_set_cull_mask** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)**
|
||
|
||
Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to :ref:`ReflectionProbe.cull_mask<class_ReflectionProbe_property_cull_mask>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_enable_box_projection:
|
||
|
||
- void **reflection_probe_set_enable_box_projection** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, uses box projection. This can make reflections look more correct in certain situations. Equivalent to :ref:`ReflectionProbe.box_projection<class_ReflectionProbe_property_box_projection>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_enable_shadows:
|
||
|
||
- void **reflection_probe_set_enable_shadows** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
|
||
|
||
If ``true``, computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to :ref:`ReflectionProbe.enable_shadows<class_ReflectionProbe_property_enable_shadows>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_extents:
|
||
|
||
- void **reflection_probe_set_extents** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` extents **)**
|
||
|
||
Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.extents<class_ReflectionProbe_property_extents>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_intensity:
|
||
|
||
- void **reflection_probe_set_intensity** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)**
|
||
|
||
Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity<class_ReflectionProbe_property_intensity>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_max_distance:
|
||
|
||
- void **reflection_probe_set_max_distance** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)**
|
||
|
||
Sets the max distance away from the probe an object can be before it is culled. Equivalent to :ref:`ReflectionProbe.max_distance<class_ReflectionProbe_property_max_distance>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold:
|
||
|
||
- void **reflection_probe_set_mesh_lod_threshold** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` pixels **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_origin_offset:
|
||
|
||
- void **reflection_probe_set_origin_offset** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)**
|
||
|
||
Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to :ref:`ReflectionProbe.origin_offset<class_ReflectionProbe_property_origin_offset>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_resolution:
|
||
|
||
- void **reflection_probe_set_resolution** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` resolution **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_reflection_probe_set_update_mode:
|
||
|
||
- void **reflection_probe_set_update_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` mode **)**
|
||
|
||
Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` for options.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_request_frame_drawn_callback:
|
||
|
||
- void **request_frame_drawn_callback** **(** :ref:`Callable<class_Callable>` callable **)**
|
||
|
||
Schedules a callback to the given callable after a frame has been drawn.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_scenario_create:
|
||
|
||
- :ref:`RID<class_RID>` **scenario_create** **(** **)**
|
||
|
||
Creates a scenario and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``scenario_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
The scenario is the 3D world that all the visual instances exist in.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_scenario_set_camera_effects:
|
||
|
||
- void **scenario_set_camera_effects** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` effects **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_scenario_set_environment:
|
||
|
||
- void **scenario_set_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
|
||
|
||
Sets the environment that will be used with this scenario.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_scenario_set_fallback_environment:
|
||
|
||
- void **scenario_set_fallback_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
|
||
|
||
Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_screen_space_roughness_limiter_set_active:
|
||
|
||
- void **screen_space_roughness_limiter_set_active** **(** :ref:`bool<class_bool>` enable, :ref:`float<class_float>` amount, :ref:`float<class_float>` limit **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_set_boot_image:
|
||
|
||
- void **set_boot_image** **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)**
|
||
|
||
Sets a boot image. The color defines the background color. If ``scale`` is ``true``, 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.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_set_debug_generate_wireframes:
|
||
|
||
- void **set_debug_generate_wireframes** **(** :ref:`bool<class_bool>` generate **)**
|
||
|
||
If ``true``, the engine will generate wireframes for use with the wireframe debug mode.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_set_default_clear_color:
|
||
|
||
- void **set_default_clear_color** **(** :ref:`Color<class_Color>` color **)**
|
||
|
||
Sets the default clear color which is used when a specific clear color has not been selected.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_shader_create:
|
||
|
||
- :ref:`RID<class_RID>` **shader_create** **(** **)**
|
||
|
||
Creates an empty shader and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``shader_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_shader_get_code:
|
||
|
||
- :ref:`String<class_String>` **shader_get_code** **(** :ref:`RID<class_RID>` shader **)** |const|
|
||
|
||
Returns a shader's code.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_shader_get_default_texture_param:
|
||
|
||
- :ref:`RID<class_RID>` **shader_get_default_texture_param** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` param, :ref:`int<class_int>` index=0 **)** |const|
|
||
|
||
Returns a default texture from a shader searched by name.
|
||
|
||
\ **Note:** If the sampler array is used use ``index`` to access the specified texture.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_shader_get_param_default:
|
||
|
||
- :ref:`Variant<class_Variant>` **shader_get_param_default** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` param **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_shader_get_param_list:
|
||
|
||
- :ref:`Dictionary[]<class_Dictionary>` **shader_get_param_list** **(** :ref:`RID<class_RID>` shader **)** |const|
|
||
|
||
Returns the parameters of a shader.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_shader_set_default_texture_param:
|
||
|
||
- void **shader_set_default_texture_param** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` param, :ref:`RID<class_RID>` texture, :ref:`int<class_int>` index=0 **)**
|
||
|
||
Sets a shader's default texture. Overwrites the texture given by name.
|
||
|
||
\ **Note:** If the sampler array is used use ``index`` to access the specified texture.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_shadows_quality_set:
|
||
|
||
- void **shadows_quality_set** **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_skeleton_allocate_data:
|
||
|
||
- void **skeleton_allocate_data** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_skeleton_bone_get_transform:
|
||
|
||
- :ref:`Transform3D<class_Transform3D>` **skeleton_bone_get_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
|
||
|
||
Returns the :ref:`Transform3D<class_Transform3D>` set for a specific bone of this skeleton.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_skeleton_bone_get_transform_2d:
|
||
|
||
- :ref:`Transform2D<class_Transform2D>` **skeleton_bone_get_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
|
||
|
||
Returns the :ref:`Transform2D<class_Transform2D>` set for a specific bone of this skeleton.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_skeleton_bone_set_transform:
|
||
|
||
- void **skeleton_bone_set_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` transform **)**
|
||
|
||
Sets the :ref:`Transform3D<class_Transform3D>` for a specific bone of this skeleton.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_skeleton_bone_set_transform_2d:
|
||
|
||
- void **skeleton_bone_set_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||
|
||
Sets the :ref:`Transform2D<class_Transform2D>` for a specific bone of this skeleton.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_skeleton_create:
|
||
|
||
- :ref:`RID<class_RID>` **skeleton_create** **(** **)**
|
||
|
||
Creates a skeleton and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``skeleton_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_skeleton_get_bone_count:
|
||
|
||
- :ref:`int<class_int>` **skeleton_get_bone_count** **(** :ref:`RID<class_RID>` skeleton **)** |const|
|
||
|
||
Returns the number of bones allocated for this skeleton.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_skeleton_set_base_transform_2d:
|
||
|
||
- void **skeleton_set_base_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`Transform2D<class_Transform2D>` base_transform **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_sky_bake_panorama:
|
||
|
||
- :ref:`Image<class_Image>` **sky_bake_panorama** **(** :ref:`RID<class_RID>` sky, :ref:`float<class_float>` energy, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_sky_create:
|
||
|
||
- :ref:`RID<class_RID>` **sky_create** **(** **)**
|
||
|
||
Creates an empty sky and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``sky_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_sky_set_material:
|
||
|
||
- void **sky_set_material** **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` material **)**
|
||
|
||
Sets the material that the sky uses to render the background and reflection maps.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_sky_set_mode:
|
||
|
||
- void **sky_set_mode** **(** :ref:`RID<class_RID>` sky, :ref:`SkyMode<enum_RenderingServer_SkyMode>` mode **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_sky_set_radiance_size:
|
||
|
||
- void **sky_set_radiance_size** **(** :ref:`RID<class_RID>` sky, :ref:`int<class_int>` radiance_size **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_spot_light_create:
|
||
|
||
- :ref:`RID<class_RID>` **spot_light_create** **(** **)**
|
||
|
||
Creates a spot light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
To place in a scene, attach this spot light to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_sub_surface_scattering_set_quality:
|
||
|
||
- void **sub_surface_scattering_set_quality** **(** :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` quality **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_sub_surface_scattering_set_scale:
|
||
|
||
- void **sub_surface_scattering_set_scale** **(** :ref:`float<class_float>` scale, :ref:`float<class_float>` depth_scale **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_2d_create:
|
||
|
||
- :ref:`RID<class_RID>` **texture_2d_create** **(** :ref:`Image<class_Image>` image **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_2d_get:
|
||
|
||
- :ref:`Image<class_Image>` **texture_2d_get** **(** :ref:`RID<class_RID>` texture **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_2d_layer_get:
|
||
|
||
- :ref:`Image<class_Image>` **texture_2d_layer_get** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_2d_layered_create:
|
||
|
||
- :ref:`RID<class_RID>` **texture_2d_layered_create** **(** :ref:`Image[]<class_Image>` layers, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_2d_layered_placeholder_create:
|
||
|
||
- :ref:`RID<class_RID>` **texture_2d_layered_placeholder_create** **(** :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_2d_placeholder_create:
|
||
|
||
- :ref:`RID<class_RID>` **texture_2d_placeholder_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_2d_update:
|
||
|
||
- void **texture_2d_update** **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_3d_create:
|
||
|
||
- :ref:`RID<class_RID>` **texture_3d_create** **(** :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`bool<class_bool>` mipmaps, :ref:`Image[]<class_Image>` data **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_3d_get:
|
||
|
||
- :ref:`Image[]<class_Image>` **texture_3d_get** **(** :ref:`RID<class_RID>` texture **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_3d_placeholder_create:
|
||
|
||
- :ref:`RID<class_RID>` **texture_3d_placeholder_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_3d_update:
|
||
|
||
- void **texture_3d_update** **(** :ref:`RID<class_RID>` texture, :ref:`Image[]<class_Image>` data **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_get_path:
|
||
|
||
- :ref:`String<class_String>` **texture_get_path** **(** :ref:`RID<class_RID>` texture **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_proxy_create:
|
||
|
||
- :ref:`RID<class_RID>` **texture_proxy_create** **(** :ref:`RID<class_RID>` base **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_proxy_update:
|
||
|
||
- void **texture_proxy_update** **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` proxy_to **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_replace:
|
||
|
||
- void **texture_replace** **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` by_texture **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_set_force_redraw_if_visible:
|
||
|
||
- void **texture_set_force_redraw_if_visible** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_set_path:
|
||
|
||
- void **texture_set_path** **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_texture_set_size_override:
|
||
|
||
- void **texture_set_size_override** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_attach_camera:
|
||
|
||
- void **viewport_attach_camera** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)**
|
||
|
||
Sets a viewport's camera.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_attach_canvas:
|
||
|
||
- void **viewport_attach_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
|
||
|
||
Sets a viewport's canvas.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_attach_to_screen:
|
||
|
||
- void **viewport_attach_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0), :ref:`int<class_int>` screen=0 **)**
|
||
|
||
Copies the viewport to a region of the screen specified by ``rect``. If :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>` is ``true``, then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.
|
||
|
||
For example, you can set the root viewport to not render at all with the following code:
|
||
|
||
FIXME: The method seems to be non-existent.
|
||
|
||
|
||
.. tabs::
|
||
|
||
.. code-tab:: gdscript
|
||
|
||
func _ready():
|
||
get_viewport().set_attach_to_screen_rect(Rect2())
|
||
$Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))
|
||
|
||
|
||
|
||
Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For a further optimization see, :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_create:
|
||
|
||
- :ref:`RID<class_RID>` **viewport_create** **(** **)**
|
||
|
||
Creates an empty viewport and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``viewport_*`` RenderingServer functions.
|
||
|
||
Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` static method.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_get_measured_render_time_cpu:
|
||
|
||
- :ref:`float<class_float>` **viewport_get_measured_render_time_cpu** **(** :ref:`RID<class_RID>` viewport **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_get_measured_render_time_gpu:
|
||
|
||
- :ref:`float<class_float>` **viewport_get_measured_render_time_gpu** **(** :ref:`RID<class_RID>` viewport **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_get_render_info:
|
||
|
||
- :ref:`int<class_int>` **viewport_get_render_info** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` type, :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` info **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_get_texture:
|
||
|
||
- :ref:`RID<class_RID>` **viewport_get_texture** **(** :ref:`RID<class_RID>` viewport **)** |const|
|
||
|
||
Returns the viewport's last rendered frame.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_remove_canvas:
|
||
|
||
- void **viewport_remove_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
|
||
|
||
Detaches a viewport from a canvas and vice versa.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_active:
|
||
|
||
- void **viewport_set_active** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)**
|
||
|
||
If ``true``, sets the viewport active, else sets it inactive.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_canvas_stacking:
|
||
|
||
- void **viewport_set_canvas_stacking** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` layer, :ref:`int<class_int>` sublayer **)**
|
||
|
||
Sets the stacking order for a viewport's canvas.
|
||
|
||
\ ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_canvas_transform:
|
||
|
||
- void **viewport_set_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)**
|
||
|
||
Sets the transformation of a viewport's canvas.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_clear_mode:
|
||
|
||
- void **viewport_set_clear_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` clear_mode **)**
|
||
|
||
Sets the clear mode of a viewport. See :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` for options.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_debug_draw:
|
||
|
||
- void **viewport_set_debug_draw** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` draw **)**
|
||
|
||
Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` for options.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter:
|
||
|
||
- void **viewport_set_default_canvas_item_texture_filter** **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat:
|
||
|
||
- void **viewport_set_default_canvas_item_texture_repeat** **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_disable_2d:
|
||
|
||
- void **viewport_set_disable_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)**
|
||
|
||
If ``true``, the viewport's canvas is not rendered.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_disable_3d:
|
||
|
||
- void **viewport_set_disable_3d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_disable_environment:
|
||
|
||
- void **viewport_set_disable_environment** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disabled **)**
|
||
|
||
If ``true``, rendering of a viewport's environment is disabled.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_fsr_mipmap_bias:
|
||
|
||
- void **viewport_set_fsr_mipmap_bias** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` mipmap_bias **)**
|
||
|
||
Affects the final texture sharpness by reading from a lower or higher mipmap. Negative values make textures sharper, while positive values make textures blurrier. When using FSR, this value is used to adjust the mipmap bias calculated internally which is based on the selected quality. The formula for this is ``-log2(1.0 / scale) + mipmap_bias``
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_fsr_sharpness:
|
||
|
||
- void **viewport_set_fsr_sharpness** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` sharpness **)**
|
||
|
||
Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_global_canvas_transform:
|
||
|
||
- void **viewport_set_global_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)**
|
||
|
||
Sets the viewport's global transformation matrix.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_measure_render_time:
|
||
|
||
- void **viewport_set_measure_render_time** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_msaa:
|
||
|
||
- void **viewport_set_msaa** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)**
|
||
|
||
Sets the anti-aliasing mode. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality:
|
||
|
||
- void **viewport_set_occlusion_culling_build_quality** **(** :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` quality **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread:
|
||
|
||
- void **viewport_set_occlusion_rays_per_thread** **(** :ref:`int<class_int>` rays_per_thread **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_parent_viewport:
|
||
|
||
- void **viewport_set_parent_viewport** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)**
|
||
|
||
Sets the viewport's parent to another viewport.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_render_direct_to_screen:
|
||
|
||
- void **viewport_set_render_direct_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
If ``true``, render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the ``SCREEN_TEXTURE``. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_scaling_3d_mode:
|
||
|
||
- void **viewport_set_scaling_3d_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` scaling_3d_mode **)**
|
||
|
||
Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_scaling_3d_scale:
|
||
|
||
- void **viewport_set_scaling_3d_scale** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` scale **)**
|
||
|
||
Scales the 3D render buffer based on the viewport size uses an image filter specified in :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` to scale the output image to the full viewport size. Values lower than ``1.0`` can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than ``1.0`` are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons.
|
||
|
||
When using FSR upscaling, AMD recommends exposing the following values as preset options to users "Ultra Quality: 0.77", "Quality: 0.67", "Balanced: 0.59", "Performance: 0.5" instead of exposing the entire scale.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_scenario:
|
||
|
||
- void **viewport_set_scenario** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)**
|
||
|
||
Sets a viewport's scenario.
|
||
|
||
The scenario contains information about environment information, reflection atlas etc.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_screen_space_aa:
|
||
|
||
- void **viewport_set_screen_space_aa** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` mode **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale:
|
||
|
||
- void **viewport_set_sdf_oversize_and_scale** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` oversize, :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` scale **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_shadow_atlas_quadrant_subdivision:
|
||
|
||
- void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)**
|
||
|
||
Sets the shadow atlas quadrant's subdivision.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_shadow_atlas_size:
|
||
|
||
- void **viewport_set_shadow_atlas_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` size, :ref:`bool<class_bool>` use_16_bits=false **)**
|
||
|
||
Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_size:
|
||
|
||
- void **viewport_set_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
|
||
|
||
Sets the viewport's width and height.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel:
|
||
|
||
- void **viewport_set_snap_2d_transforms_to_pixel** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel:
|
||
|
||
- void **viewport_set_snap_2d_vertices_to_pixel** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_transparent_background:
|
||
|
||
- void **viewport_set_transparent_background** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
|
||
|
||
If ``true``, the viewport renders its background as transparent.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_update_mode:
|
||
|
||
- void **viewport_set_update_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` update_mode **)**
|
||
|
||
Sets when the viewport should be updated. See :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` constants for options.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_use_debanding:
|
||
|
||
- void **viewport_set_use_debanding** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_use_occlusion_culling:
|
||
|
||
- void **viewport_set_use_occlusion_culling** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_viewport_set_use_xr:
|
||
|
||
- void **viewport_set_use_xr** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_xr **)**
|
||
|
||
If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface<class_XRInterface>`.
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_visibility_notifier_create:
|
||
|
||
- :ref:`RID<class_RID>` **visibility_notifier_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_visibility_notifier_set_aabb:
|
||
|
||
- void **visibility_notifier_set_aabb** **(** :ref:`RID<class_RID>` notifier, :ref:`AABB<class_AABB>` aabb **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_visibility_notifier_set_callbacks:
|
||
|
||
- void **visibility_notifier_set_callbacks** **(** :ref:`RID<class_RID>` notifier, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_allocate_data:
|
||
|
||
- void **voxel_gi_allocate_data** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`Transform3D<class_Transform3D>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3i<class_Vector3i>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_create:
|
||
|
||
- :ref:`RID<class_RID>` **voxel_gi_create** **(** **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_get_data_cells:
|
||
|
||
- :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_data_cells** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_get_distance_field:
|
||
|
||
- :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_distance_field** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_get_level_counts:
|
||
|
||
- :ref:`PackedInt32Array<class_PackedInt32Array>` **voxel_gi_get_level_counts** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_get_octree_cells:
|
||
|
||
- :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_octree_cells** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_get_octree_size:
|
||
|
||
- :ref:`Vector3i<class_Vector3i>` **voxel_gi_get_octree_size** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_get_to_cell_xform:
|
||
|
||
- :ref:`Transform3D<class_Transform3D>` **voxel_gi_get_to_cell_xform** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_set_bias:
|
||
|
||
- void **voxel_gi_set_bias** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_set_dynamic_range:
|
||
|
||
- void **voxel_gi_set_dynamic_range** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` range **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_set_energy:
|
||
|
||
- void **voxel_gi_set_energy** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` energy **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_set_interior:
|
||
|
||
- void **voxel_gi_set_interior** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_set_normal_bias:
|
||
|
||
- void **voxel_gi_set_normal_bias** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_set_propagation:
|
||
|
||
- void **voxel_gi_set_propagation** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` amount **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_set_quality:
|
||
|
||
- void **voxel_gi_set_quality** **(** :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` quality **)**
|
||
|
||
----
|
||
|
||
.. _class_RenderingServer_method_voxel_gi_set_use_two_bounces:
|
||
|
||
- void **voxel_gi_set_use_two_bounces** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)**
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
||
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
||
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
||
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|