:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderingServer.xml. .. _class_RenderingServer: RenderingServer =============== **Inherits:** :ref:`Object` Server for anything visible. .. rst-class:: classref-introduction-group Description ----------- 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/:ref:`Node` system entirely. Resources are created using the ``*_create`` functions. These functions return :ref:`RID`\ s which are not references to the objects themselves, but opaque *pointers* towards these objects. All objects are drawn to a viewport. You can use the :ref:`Viewport` attached to the :ref:`SceneTree` or you can create one yourself with :ref:`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` or :ref:`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` node with :ref:`Node3D.get_world_3d`. Otherwise, a scenario can be created with :ref:`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`. The instance must also be attached to the scenario using :ref:`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. \ **Headless mode:** Starting the engine with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` disables all rendering and window management functions. Most functions from **RenderingServer** will return dummy values in this case. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Optimization using Servers <../tutorials/performance/using_servers>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------+--------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`render_loop_enabled` | +-------------------------+--------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image[]` | :ref:`bake_render_uv2` **(** :ref:`RID` base, :ref:`RID[]` material_overrides, :ref:`Vector2i` image_size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`camera_attributes_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_attributes_set_auto_exposure` **(** :ref:`RID` camera_attributes, :ref:`bool` enable, :ref:`float` min_sensitivity, :ref:`float` max_sensitivity, :ref:`float` speed, :ref:`float` scale **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_attributes_set_dof_blur` **(** :ref:`RID` camera_attributes, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_attributes_set_dof_blur_bokeh_shape` **(** :ref:`DOFBokehShape` shape **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_attributes_set_dof_blur_quality` **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_attributes_set_exposure` **(** :ref:`RID` camera_attributes, :ref:`float` multiplier, :ref:`float` normalization **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`camera_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_camera_attributes` **(** :ref:`RID` camera, :ref:`RID` effects **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_frustum` **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform3D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_animation_slice` **(** :ref:`RID` item, :ref:`float` animation_length, :ref:`float` slice_begin, :ref:`float` slice_end, :ref:`float` offset=0.0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_lcd_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_msdf_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`float` px_range=1.0, :ref:`float` scale=1.0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PackedInt32Array` indices, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedInt32Array` bones=PackedInt32Array(), :ref:`PackedFloat32Array` weights=PackedFloat32Array(), :ref:`RID` texture, :ref:`int` count=-1 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_item_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_canvas_group_mode` **(** :ref:`RID` item, :ref:`CanvasGroupMode` mode, :ref:`float` clear_margin=5.0, :ref:`bool` fit_empty=false, :ref:`float` fit_margin=0.0, :ref:`bool` blur_mipmaps=false **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_default_texture_filter` **(** :ref:`RID` item, :ref:`CanvasItemTextureFilter` filter **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_default_texture_repeat` **(** :ref:`RID` item, :ref:`CanvasItemTextureRepeat` repeat **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_visibility_layer` **(** :ref:`RID` item, :ref:`int` visibility_layer **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_visibility_notifier` **(** :ref:`RID` item, :ref:`bool` enable, :ref:`Rect2` area, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_light_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_as_sdf_collision` **(** :ref:`RID` occluder, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_blend_mode` **(** :ref:`RID` light, :ref:`CanvasLightBlendMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_texture_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape, :ref:`bool` closed **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_set_disable_scale` **(** :ref:`bool` disable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_set_shadow_texture_size` **(** :ref:`int` size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`canvas_texture_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_texture_set_channel` **(** :ref:`RID` canvas_texture, :ref:`CanvasTextureChannel` channel, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_texture_set_shading_parameters` **(** :ref:`RID` canvas_texture, :ref:`Color` base_color, :ref:`float` shininess **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_texture_set_texture_filter` **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureFilter` filter **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_texture_set_texture_repeat` **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureRepeat` repeat **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RenderingDevice` | :ref:`create_local_rendering_device` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`decal_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_albedo_mix` **(** :ref:`RID` decal, :ref:`float` albedo_mix **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_cull_mask` **(** :ref:`RID` decal, :ref:`int` mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_distance_fade` **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` length **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_emission_energy` **(** :ref:`RID` decal, :ref:`float` energy **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_fade` **(** :ref:`RID` decal, :ref:`float` above, :ref:`float` below **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_modulate` **(** :ref:`RID` decal, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_normal_fade` **(** :ref:`RID` decal, :ref:`float` fade **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_size` **(** :ref:`RID` decal, :ref:`Vector3` size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decal_set_texture` **(** :ref:`RID` decal, :ref:`DecalTexture` type, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`decals_set_filter` **(** :ref:`DecalFilter` filter **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`directional_light_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`directional_shadow_atlas_set_size` **(** :ref:`int` size, :ref:`bool` is_16bits **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`directional_soft_shadow_filter_set_quality` **(** :ref:`ShadowQuality` quality **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`environment_bake_panorama` **(** :ref:`RID` environment, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`environment_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_glow_set_use_bicubic_upscale` **(** :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`bool` use_1d_color_correction, :ref:`RID` color_correction **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` multiplier, :ref:`float` exposure_value **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective, :ref:`float` sky_affect **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`PackedFloat32Array` levels, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`float` glow_map_strength, :ref:`RID` glow_map **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sdfgi` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` cascades, :ref:`float` min_cell_size, :ref:`EnvironmentSDFGIYScale` y_scale, :ref:`bool` use_occlusion, :ref:`float` bounce_feedback, :ref:`bool` read_sky, :ref:`float` energy, :ref:`float` normal_bias, :ref:`float` probe_bias **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sdfgi_frames_to_converge` **(** :ref:`EnvironmentSDFGIFramesToConverge` frames **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sdfgi_frames_to_update_light` **(** :ref:`EnvironmentSDFGIFramesToUpdateLight` frames **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sdfgi_ray_count` **(** :ref:`EnvironmentSDFGIRayCount` ray_count **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` power, :ref:`float` detail, :ref:`float` horizon, :ref:`float` sharpness, :ref:`float` light_affect, :ref:`float` ao_channel_affect **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_ssao_quality` **(** :ref:`EnvironmentSSAOQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_ssil_quality` **(** :ref:`EnvironmentSSILQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_ssr_roughness_quality` **(** :ref:`EnvironmentSSRRoughnessQuality` quality **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_volumetric_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject, :ref:`float` sky_affect **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_volumetric_fog_filter_active` **(** :ref:`bool` active **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_volumetric_fog_volume_size` **(** :ref:`int` size, :ref:`int` depth **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`fog_volume_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fog_volume_set_material` **(** :ref:`RID` fog_volume, :ref:`RID` material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fog_volume_set_shape` **(** :ref:`RID` fog_volume, :ref:`FogVolumeShape` shape **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fog_volume_set_size` **(** :ref:`RID` fog_volume, :ref:`Vector3` size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_sync` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`free_rid` **(** :ref:`RID` rid **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_default_clear_color` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_frame_setup_time_cpu` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RenderingDevice` | :ref:`get_rendering_device` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_rendering_info` **(** :ref:`RenderingInfo` info **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`get_shader_parameter_list` **(** :ref:`RID` shader **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_test_cube` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_test_texture` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_video_adapter_api_version` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_video_adapter_name` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`DeviceType` | :ref:`get_video_adapter_type` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_white_texture` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`gi_set_use_half_resolution` **(** :ref:`bool` half_resolution **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_shader_parameter_add` **(** :ref:`StringName` name, :ref:`GlobalShaderParameterType` type, :ref:`Variant` default_value **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`global_shader_parameter_get` **(** :ref:`StringName` name **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`global_shader_parameter_get_list` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GlobalShaderParameterType` | :ref:`global_shader_parameter_get_type` **(** :ref:`StringName` name **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_shader_parameter_remove` **(** :ref:`StringName` name **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_shader_parameter_set` **(** :ref:`StringName` name, :ref:`Variant` value **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`global_shader_parameter_set_override` **(** :ref:`StringName` name, :ref:`Variant` value **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_changed` **(** **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`instance_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter` **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter_default_value` **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`instance_geometry_get_shader_parameter_list` **(** :ref:`RID` instance **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap, :ref:`Rect2` lightmap_uv_scale, :ref:`int` lightmap_slice **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_lod_bias` **(** :ref:`RID` instance, :ref:`float` lod_bias **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_material_overlay` **(** :ref:`RID` instance, :ref:`RID` material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_shader_parameter` **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_transparency` **(** :ref:`RID` instance, :ref:`float` transparency **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_geometry_set_visibility_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin, :ref:`VisibilityRangeFadeMode` fade_mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_ignore_culling` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_pivot_data` **(** :ref:`RID` instance, :ref:`float` sorting_offset, :ref:`bool` use_aabb_center **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_surface_override_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform3D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_visibility_parent` **(** :ref:`RID` instance, :ref:`RID` parent **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_convex` **(** :ref:`Plane[]` convex, :ref:`RID` scenario **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt64Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_directional_set_sky_mode` **(** :ref:`RID` light, :ref:`LightDirectionalSkyMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_projectors_set_filter` **(** :ref:`LightProjectorFilter` filter **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_bake_mode` **(** :ref:`RID` light, :ref:`LightBakeMode` bake_mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_distance_fade` **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` shadow, :ref:`float` length **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_max_sdfgi_cascade` **(** :ref:`RID` light, :ref:`int` cascade **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`lightmap_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_bsp_tree` **(** :ref:`RID` lightmap **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`lightmap_get_probe_capture_points` **(** :ref:`RID` lightmap **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedColorArray` | :ref:`lightmap_get_probe_capture_sh` **(** :ref:`RID` lightmap **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_tetrahedra` **(** :ref:`RID` lightmap **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lightmap_set_baked_exposure_normalization` **(** :ref:`RID` lightmap, :ref:`float` baked_exposure **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lightmap_set_probe_bounds` **(** :ref:`RID` lightmap, :ref:`AABB` bounds **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lightmap_set_probe_capture_data` **(** :ref:`RID` lightmap, :ref:`PackedVector3Array` points, :ref:`PackedColorArray` point_sh, :ref:`PackedInt32Array` tetrahedra, :ref:`PackedInt32Array` bsp_tree **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lightmap_set_probe_capture_update_speed` **(** :ref:`float` speed **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lightmap_set_probe_interior` **(** :ref:`RID` lightmap, :ref:`bool` interior **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`lightmap_set_textures` **(** :ref:`RID` lightmap, :ref:`RID` light, :ref:`bool` uses_sh **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`material_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`StringName` parameter **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`StringName` parameter, :ref:`Variant` value **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_add_surface` **(** :ref:`RID` mesh, :ref:`Dictionary` surface **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`ArrayFormat` compress_format=0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`mesh_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`mesh_create_from_surfaces` **(** :ref:`Dictionary[]` surfaces, :ref:`int` blend_shape_count=0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`mesh_get_surface` **(** :ref:`RID` mesh, :ref:`int` surface **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_set_shadow_mesh` **(** :ref:`RID` mesh, :ref:`RID` shadow_mesh **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array[]` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_attribute_stride` **(** :ref:`ArrayFormat` format, :ref:`int` vertex_count **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`ArrayFormat` format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_skin_stride` **(** :ref:`ArrayFormat` format, :ref:`int` vertex_count **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mesh_surface_get_format_vertex_stride` **(** :ref:`ArrayFormat` format, :ref:`int` vertex_count **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_surface_update_attribute_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_surface_update_skin_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mesh_surface_update_vertex_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_allocate_data` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`multimesh_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat32Array` | :ref:`multimesh_get_buffer` **(** :ref:`RID` multimesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform3D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_set_buffer` **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`occluder_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`occluder_set_mesh` **(** :ref:`RID` occluder, :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`omni_light_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`particles_collision_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_height_field_update` **(** :ref:`RID` particles_collision **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_attractor_attenuation` **(** :ref:`RID` particles_collision, :ref:`float` curve **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_attractor_directionality` **(** :ref:`RID` particles_collision, :ref:`float` amount **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_attractor_strength` **(** :ref:`RID` particles_collision, :ref:`float` setrngth **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_box_extents` **(** :ref:`RID` particles_collision, :ref:`Vector3` extents **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_collision_type` **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionType` type **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_cull_mask` **(** :ref:`RID` particles_collision, :ref:`int` mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_field_texture` **(** :ref:`RID` particles_collision, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_height_field_resolution` **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution` resolution **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_collision_set_sphere_radius` **(** :ref:`RID` particles_collision, :ref:`float` radius **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`particles_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_emit` **(** :ref:`RID` particles, :ref:`Transform3D` transform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` emit_flags **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`particles_is_inactive` **(** :ref:`RID` particles **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_request_process` **(** :ref:`RID` particles **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_collision_base_size` **(** :ref:`RID` particles, :ref:`float` size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform3D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_interpolate` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_mode` **(** :ref:`RID` particles, :ref:`ParticlesMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_subemitter` **(** :ref:`RID` particles, :ref:`RID` subemitter_particles **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_trail_bind_poses` **(** :ref:`RID` particles, :ref:`Transform3D[]` bind_poses **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_trails` **(** :ref:`RID` particles, :ref:`bool` enable, :ref:`float` length_sec **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_transform_align` **(** :ref:`RID` particles, :ref:`ParticlesTransformAlign` align **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`positional_soft_shadow_filter_set_quality` **(** :ref:`ShadowQuality` quality **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_ambient_color` **(** :ref:`RID` probe, :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_ambient_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeAmbientMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_mesh_lod_threshold` **(** :ref:`RID` probe, :ref:`float` pixels **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_resolution` **(** :ref:`RID` probe, :ref:`int` resolution **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_size` **(** :ref:`RID` probe, :ref:`Vector3` size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`request_frame_drawn_callback` **(** :ref:`Callable` callable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`scenario_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scenario_set_camera_attributes` **(** :ref:`RID` scenario, :ref:`RID` effects **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`screen_space_roughness_limiter_set_active` **(** :ref:`bool` enable, :ref:`float` amount, :ref:`float` limit **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`bool` use_filter=true **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shader_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`shader_get_default_texture_parameter` **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`int` index=0 **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`shader_get_parameter_default` **(** :ref:`RID` shader, :ref:`StringName` name **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shader_set_default_texture_parameter` **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`RID` texture, :ref:`int` index=0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shader_set_path_hint` **(** :ref:`RID` shader, :ref:`String` path **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skeleton_allocate_data` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform3D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`skeleton_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`skeleton_set_base_transform_2d` **(** :ref:`RID` skeleton, :ref:`Transform2D` base_transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`sky_bake_panorama` **(** :ref:`RID` sky, :ref:`float` energy, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`sky_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sky_set_material` **(** :ref:`RID` sky, :ref:`RID` material **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sky_set_mode` **(** :ref:`RID` sky, :ref:`SkyMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sky_set_radiance_size` **(** :ref:`RID` sky, :ref:`int` radiance_size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`spot_light_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sub_surface_scattering_set_quality` **(** :ref:`SubSurfaceScatteringQuality` quality **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`sub_surface_scattering_set_scale` **(** :ref:`float` scale, :ref:`float` depth_scale **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_2d_create` **(** :ref:`Image` image **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`texture_2d_get` **(** :ref:`RID` texture **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`texture_2d_layer_get` **(** :ref:`RID` texture, :ref:`int` layer **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_2d_layered_create` **(** :ref:`Image[]` layers, :ref:`TextureLayeredType` layered_type **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_2d_layered_placeholder_create` **(** :ref:`TextureLayeredType` layered_type **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_2d_placeholder_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_2d_update` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_3d_create` **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` mipmaps, :ref:`Image[]` data **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image[]` | :ref:`texture_3d_get` **(** :ref:`RID` texture **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_3d_placeholder_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_3d_update` **(** :ref:`RID` texture, :ref:`Image[]` data **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_get_rd_texture` **(** :ref:`RID` texture, :ref:`bool` srgb=false **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_proxy_create` **(** :ref:`RID` base **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_proxy_update` **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_replace` **(** :ref:`RID` texture, :ref:`RID` by_texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_set_force_redraw_if_visible` **(** :ref:`RID` texture, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2(0, 0, 0, 0), :ref:`int` screen=0 **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`viewport_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`viewport_get_measured_render_time_cpu` **(** :ref:`RID` viewport **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`viewport_get_measured_render_time_gpu` **(** :ref:`RID` viewport **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfoType` type, :ref:`ViewportRenderInfo` info **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_canvas_cull_mask` **(** :ref:`RID` viewport, :ref:`int` canvas_cull_mask **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_canvas_stacking` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_default_canvas_item_texture_filter` **(** :ref:`RID` viewport, :ref:`CanvasItemTextureFilter` filter **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_default_canvas_item_texture_repeat` **(** :ref:`RID` viewport, :ref:`CanvasItemTextureRepeat` repeat **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_disable_2d` **(** :ref:`RID` viewport, :ref:`bool` disable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_environment_mode` **(** :ref:`RID` viewport, :ref:`ViewportEnvironmentMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_fsr_sharpness` **(** :ref:`RID` viewport, :ref:`float` sharpness **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_measure_render_time` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_msaa_2d` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_msaa_3d` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_occlusion_culling_build_quality` **(** :ref:`ViewportOcclusionCullingBuildQuality` quality **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_occlusion_rays_per_thread` **(** :ref:`int` rays_per_thread **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_positional_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size, :ref:`bool` use_16_bits=false **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_scaling_3d_mode` **(** :ref:`RID` viewport, :ref:`ViewportScaling3DMode` scaling_3d_mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_scaling_3d_scale` **(** :ref:`RID` viewport, :ref:`float` scale **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_screen_space_aa` **(** :ref:`RID` viewport, :ref:`ViewportScreenSpaceAA` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_sdf_oversize_and_scale` **(** :ref:`RID` viewport, :ref:`ViewportSDFOversize` oversize, :ref:`ViewportSDFScale` scale **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_snap_2d_transforms_to_pixel` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_snap_2d_vertices_to_pixel` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_texture_mipmap_bias` **(** :ref:`RID` viewport, :ref:`float` mipmap_bias **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_use_debanding` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_use_occlusion_culling` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_use_taa` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_use_xr` **(** :ref:`RID` viewport, :ref:`bool` use_xr **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_vrs_mode` **(** :ref:`RID` viewport, :ref:`ViewportVRSMode` mode **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`viewport_set_vrs_texture` **(** :ref:`RID` viewport, :ref:`RID` texture **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`visibility_notifier_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`visibility_notifier_set_aabb` **(** :ref:`RID` notifier, :ref:`AABB` aabb **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`visibility_notifier_set_callbacks` **(** :ref:`RID` notifier, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_allocate_data` **(** :ref:`RID` voxel_gi, :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3i` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`voxel_gi_create` **(** **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`voxel_gi_get_data_cells` **(** :ref:`RID` voxel_gi **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`voxel_gi_get_distance_field` **(** :ref:`RID` voxel_gi **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`voxel_gi_get_level_counts` **(** :ref:`RID` voxel_gi **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`voxel_gi_get_octree_cells` **(** :ref:`RID` voxel_gi **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i` | :ref:`voxel_gi_get_octree_size` **(** :ref:`RID` voxel_gi **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`voxel_gi_get_to_cell_xform` **(** :ref:`RID` voxel_gi **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_baked_exposure_normalization` **(** :ref:`RID` voxel_gi, :ref:`float` baked_exposure **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_bias` **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_dynamic_range` **(** :ref:`RID` voxel_gi, :ref:`float` range **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_energy` **(** :ref:`RID` voxel_gi, :ref:`float` energy **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_interior` **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_normal_bias` **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_propagation` **(** :ref:`RID` voxel_gi, :ref:`float` amount **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_quality` **(** :ref:`VoxelGIQuality` quality **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`voxel_gi_set_use_two_bounces` **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_RenderingServer_signal_frame_post_draw: .. rst-class:: classref-signal **frame_post_draw** **(** **)** Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_signal_frame_pre_draw: .. rst-class:: classref-signal **frame_pre_draw** **(** **)** Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_RenderingServer_TextureLayeredType: .. rst-class:: classref-enumeration enum **TextureLayeredType**: .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY: .. rst-class:: classref-enumeration-constant :ref:`TextureLayeredType` **TEXTURE_LAYERED_2D_ARRAY** = ``0`` .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP: .. rst-class:: classref-enumeration-constant :ref:`TextureLayeredType` **TEXTURE_LAYERED_CUBEMAP** = ``1`` .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY: .. rst-class:: classref-enumeration-constant :ref:`TextureLayeredType` **TEXTURE_LAYERED_CUBEMAP_ARRAY** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CubeMapLayer: .. rst-class:: classref-enumeration enum **CubeMapLayer**: .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_LEFT** = ``0`` .. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_RIGHT** = ``1`` .. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_BOTTOM** = ``2`` .. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_TOP** = ``3`` .. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_FRONT** = ``4`` .. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK: .. rst-class:: classref-enumeration-constant :ref:`CubeMapLayer` **CUBEMAP_LAYER_BACK** = ``5`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ShaderMode: .. rst-class:: classref-enumeration enum **ShaderMode**: .. _class_RenderingServer_constant_SHADER_SPATIAL: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_SPATIAL** = ``0`` Shader is a 3D shader. .. _class_RenderingServer_constant_SHADER_CANVAS_ITEM: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_CANVAS_ITEM** = ``1`` Shader is a 2D shader. .. _class_RenderingServer_constant_SHADER_PARTICLES: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_PARTICLES** = ``2`` Shader is a particle shader. .. _class_RenderingServer_constant_SHADER_SKY: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_SKY** = ``3`` Shader is a sky shader. .. _class_RenderingServer_constant_SHADER_FOG: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_FOG** = ``4`` Shader is a fog shader. .. _class_RenderingServer_constant_SHADER_MAX: .. rst-class:: classref-enumeration-constant :ref:`ShaderMode` **SHADER_MAX** = ``5`` Represents the size of the :ref:`ShaderMode` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ArrayType: .. rst-class:: classref-enumeration enum **ArrayType**: .. _class_RenderingServer_constant_ARRAY_VERTEX: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_VERTEX** = ``0`` Array is a vertex array. .. _class_RenderingServer_constant_ARRAY_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_NORMAL** = ``1`` Array is a normal array. .. _class_RenderingServer_constant_ARRAY_TANGENT: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_TANGENT** = ``2`` Array is a tangent array. .. _class_RenderingServer_constant_ARRAY_COLOR: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_COLOR** = ``3`` Array is a color array. .. _class_RenderingServer_constant_ARRAY_TEX_UV: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_TEX_UV** = ``4`` Array is an UV coordinates array. .. _class_RenderingServer_constant_ARRAY_TEX_UV2: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_TEX_UV2** = ``5`` Array is an UV coordinates array for the second UV coordinates. .. _class_RenderingServer_constant_ARRAY_CUSTOM0: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_CUSTOM0** = ``6`` .. _class_RenderingServer_constant_ARRAY_CUSTOM1: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_CUSTOM1** = ``7`` .. _class_RenderingServer_constant_ARRAY_CUSTOM2: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_CUSTOM2** = ``8`` .. _class_RenderingServer_constant_ARRAY_CUSTOM3: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_CUSTOM3** = ``9`` .. _class_RenderingServer_constant_ARRAY_BONES: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_BONES** = ``10`` Array contains bone information. .. _class_RenderingServer_constant_ARRAY_WEIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_WEIGHTS** = ``11`` Array is weight information. .. _class_RenderingServer_constant_ARRAY_INDEX: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_INDEX** = ``12`` Array is index array. .. _class_RenderingServer_constant_ARRAY_MAX: .. rst-class:: classref-enumeration-constant :ref:`ArrayType` **ARRAY_MAX** = ``13`` Represents the size of the :ref:`ArrayType` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ArrayCustomFormat: .. rst-class:: classref-enumeration enum **ArrayCustomFormat**: .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGBA8_UNORM** = ``0`` .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGBA8_SNORM** = ``1`` .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RG_HALF** = ``2`` .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGBA_HALF** = ``3`` .. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_R_FLOAT** = ``4`` .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RG_FLOAT** = ``5`` .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGB_FLOAT** = ``6`` .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_RGBA_FLOAT** = ``7`` .. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX: .. rst-class:: classref-enumeration-constant :ref:`ArrayCustomFormat` **ARRAY_CUSTOM_MAX** = ``8`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ArrayFormat: .. rst-class:: classref-enumeration flags **ArrayFormat**: .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_VERTEX** = ``1`` Flag used to mark a vertex array. .. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_NORMAL** = ``2`` Flag used to mark a normal array. .. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_TANGENT** = ``4`` Flag used to mark a tangent array. .. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_COLOR** = ``8`` Flag used to mark a color array. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_TEX_UV** = ``16`` Flag used to mark an UV coordinates array. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_TEX_UV2** = ``32`` Flag used to mark an UV coordinates array for the second UV coordinates. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM0** = ``64`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM1** = ``128`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM2** = ``256`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM3** = ``512`` .. _class_RenderingServer_constant_ARRAY_FORMAT_BONES: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_BONES** = ``1024`` Flag used to mark a bone information array. .. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_WEIGHTS** = ``2048`` Flag used to mark a weights array. .. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_INDEX** = ``4096`` Flag used to mark an index array. .. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_BLEND_SHAPE_MASK** = ``7`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM_BASE** = ``13`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM_BITS** = ``3`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM0_SHIFT** = ``13`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM1_SHIFT** = ``16`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM2_SHIFT** = ``19`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM3_SHIFT** = ``22`` .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FORMAT_CUSTOM_MASK** = ``7`` .. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_COMPRESS_FLAGS_BASE** = ``25`` .. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_USE_2D_VERTICES** = ``33554432`` Flag used to mark that the array contains 2D vertices. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864`` .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728`` .. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY: .. rst-class:: classref-enumeration-constant :ref:`ArrayFormat` **ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY** = ``268435456`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_PrimitiveType: .. rst-class:: classref-enumeration enum **PrimitiveType**: .. _class_RenderingServer_constant_PRIMITIVE_POINTS: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_POINTS** = ``0`` Primitive to draw consists of points. .. _class_RenderingServer_constant_PRIMITIVE_LINES: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_LINES** = ``1`` Primitive to draw consists of lines. .. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_LINE_STRIP** = ``2`` Primitive to draw consists of a line strip from start to end. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_TRIANGLES** = ``3`` Primitive to draw consists of triangles. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_TRIANGLE_STRIP** = ``4`` Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle). .. _class_RenderingServer_constant_PRIMITIVE_MAX: .. rst-class:: classref-enumeration-constant :ref:`PrimitiveType` **PRIMITIVE_MAX** = ``5`` Represents the size of the :ref:`PrimitiveType` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_BlendShapeMode: .. rst-class:: classref-enumeration enum **BlendShapeMode**: .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED: .. rst-class:: classref-enumeration-constant :ref:`BlendShapeMode` **BLEND_SHAPE_MODE_NORMALIZED** = ``0`` Blend shapes are normalized. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE: .. rst-class:: classref-enumeration-constant :ref:`BlendShapeMode` **BLEND_SHAPE_MODE_RELATIVE** = ``1`` Blend shapes are relative to base weight. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_MultimeshTransformFormat: .. rst-class:: classref-enumeration enum **MultimeshTransformFormat**: .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D: .. rst-class:: classref-enumeration-constant :ref:`MultimeshTransformFormat` **MULTIMESH_TRANSFORM_2D** = ``0`` Use :ref:`Transform2D` to store MultiMesh transform. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D: .. rst-class:: classref-enumeration-constant :ref:`MultimeshTransformFormat` **MULTIMESH_TRANSFORM_3D** = ``1`` Use :ref:`Transform3D` to store MultiMesh transform. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightProjectorFilter: .. rst-class:: classref-enumeration enum **LightProjectorFilter**: .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_NEAREST** = ``0`` Nearest-neighbor filter for light projectors (use for pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_LINEAR** = ``1`` Linear filter for light projectors (use for non-pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = ``2`` Nearest-neighbor filter for light projectors (use for pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = ``3`` Linear filter for light projectors (use for non-pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4`` Nearest-neighbor filter for light projectors (use for pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`LightProjectorFilter` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5`` Linear filter for light projectors (use for non-pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightType: .. rst-class:: classref-enumeration enum **LightType**: .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL: .. rst-class:: classref-enumeration-constant :ref:`LightType` **LIGHT_DIRECTIONAL** = ``0`` Is a directional (sun) light. .. _class_RenderingServer_constant_LIGHT_OMNI: .. rst-class:: classref-enumeration-constant :ref:`LightType` **LIGHT_OMNI** = ``1`` Is an omni light. .. _class_RenderingServer_constant_LIGHT_SPOT: .. rst-class:: classref-enumeration-constant :ref:`LightType` **LIGHT_SPOT** = ``2`` Is a spot light. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightParam: .. rst-class:: classref-enumeration enum **LightParam**: .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_ENERGY** = ``0`` The light's energy multiplier. .. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_INDIRECT_ENERGY** = ``1`` The light's indirect energy multiplier (final indirect energy is :ref:`LIGHT_PARAM_ENERGY` \* :ref:`LIGHT_PARAM_INDIRECT_ENERGY`). .. _class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY** = ``2`` The light's volumetric fog energy multiplier (final volumetric fog energy is :ref:`LIGHT_PARAM_ENERGY` \* :ref:`LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY`). .. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SPECULAR** = ``3`` The light's influence on specularity. .. _class_RenderingServer_constant_LIGHT_PARAM_RANGE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_RANGE** = ``4`` The light's range. .. _class_RenderingServer_constant_LIGHT_PARAM_SIZE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SIZE** = ``5`` The size of the light when using spot light or omni light. The angular size of the light when using directional light. .. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_ATTENUATION** = ``6`` The light's attenuation. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SPOT_ANGLE** = ``7`` The spotlight's angle. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SPOT_ATTENUATION** = ``8`` The spotlight's attenuation. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = ``9`` Max distance that shadows will be rendered. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = ``10`` Proportion of shadow atlas occupied by the first split. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = ``11`` Proportion of shadow atlas occupied by the second split. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = ``12`` Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_FADE_START** = ``13`` Proportion of shadow max distance where the shadow will start to fade out. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = ``14`` Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_BIAS** = ``15`` Bias the shadow lookup to fix self-shadowing artifacts. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = ``16`` 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. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_OPACITY: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_OPACITY** = ``17`` The light's shadow opacity. Values lower than ``1.0`` make the light appear through shadows. This can be used to fake global illumination at a low performance cost. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_SHADOW_BLUR** = ``18`` 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. .. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_TRANSMITTANCE_BIAS** = ``19`` .. _class_RenderingServer_constant_LIGHT_PARAM_MAX: .. rst-class:: classref-enumeration-constant :ref:`LightParam` **LIGHT_PARAM_MAX** = ``21`` Represents the size of the :ref:`LightParam` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightBakeMode: .. rst-class:: classref-enumeration enum **LightBakeMode**: .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`LightBakeMode` **LIGHT_BAKE_DISABLED** = ``0`` .. _class_RenderingServer_constant_LIGHT_BAKE_STATIC: .. rst-class:: classref-enumeration-constant :ref:`LightBakeMode` **LIGHT_BAKE_STATIC** = ``1`` .. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC: .. rst-class:: classref-enumeration-constant :ref:`LightBakeMode` **LIGHT_BAKE_DYNAMIC** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightOmniShadowMode: .. rst-class:: classref-enumeration enum **LightOmniShadowMode**: .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID: .. rst-class:: classref-enumeration-constant :ref:`LightOmniShadowMode` **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = ``0`` Use a dual paraboloid shadow map for omni lights. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE: .. rst-class:: classref-enumeration-constant :ref:`LightOmniShadowMode` **LIGHT_OMNI_SHADOW_CUBE** = ``1`` Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightDirectionalShadowMode: .. rst-class:: classref-enumeration enum **LightDirectionalShadowMode**: .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = ``0`` Use orthogonal shadow projection for directional light. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = ``1`` Use 2 splits for shadow projection when using directional light. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalShadowMode` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2`` Use 4 splits for shadow projection when using directional light. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_LightDirectionalSkyMode: .. rst-class:: classref-enumeration enum **LightDirectionalSkyMode**: .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalSkyMode` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY** = ``0`` Use DirectionalLight3D in both sky rendering and scene lighting. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalSkyMode` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY** = ``1`` Only use DirectionalLight3D in scene lighting. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY: .. rst-class:: classref-enumeration-constant :ref:`LightDirectionalSkyMode` **LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY** = ``2`` Only use DirectionalLight3D in sky rendering. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ShadowQuality: .. rst-class:: classref-enumeration enum **ShadowQuality**: .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD: .. rst-class:: classref-enumeration-constant :ref:`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` property is ignored if :ref:`Light3D.light_size` and :ref:`Light3D.light_angular_distance` is ``0.0``. \ **Note:** The variable shadow blur performed by :ref:`Light3D.light_size` and :ref:`Light3D.light_angular_distance` is still effective when using hard shadow filtering. In this case, :ref:`Light3D.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. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_VERY_LOW** = ``1`` Very low shadow filtering quality (faster). When using this quality setting, :ref:`Light3D.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` or :ref:`Light3D.light_angular_distance` is ``0.0``). .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_LOW** = ``2`` Low shadow filtering quality (fast). .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_MEDIUM** = ``3`` Medium low shadow filtering quality (average). .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_HIGH** = ``4`` High low shadow filtering quality (slow). When using this quality setting, :ref:`Light3D.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` or :ref:`Light3D.light_angular_distance` is ``0.0``). .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_SOFT_ULTRA** = ``5`` Highest low shadow filtering quality (slowest). When using this quality setting, :ref:`Light3D.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` or :ref:`Light3D.light_angular_distance` is ``0.0``). .. _class_RenderingServer_constant_SHADOW_QUALITY_MAX: .. rst-class:: classref-enumeration-constant :ref:`ShadowQuality` **SHADOW_QUALITY_MAX** = ``6`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ReflectionProbeUpdateMode: .. rst-class:: classref-enumeration enum **ReflectionProbeUpdateMode**: .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeUpdateMode` **REFLECTION_PROBE_UPDATE_ONCE** = ``0`` Reflection probe will update reflections once and then stop. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeUpdateMode` **REFLECTION_PROBE_UPDATE_ALWAYS** = ``1`` Reflection probe will update each frame. This mode is necessary to capture moving objects. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ReflectionProbeAmbientMode: .. rst-class:: classref-enumeration enum **ReflectionProbeAmbientMode**: .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeAmbientMode` **REFLECTION_PROBE_AMBIENT_DISABLED** = ``0`` .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeAmbientMode` **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = ``1`` .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR: .. rst-class:: classref-enumeration-constant :ref:`ReflectionProbeAmbientMode` **REFLECTION_PROBE_AMBIENT_COLOR** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_DecalTexture: .. rst-class:: classref-enumeration enum **DecalTexture**: .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_ALBEDO** = ``0`` .. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_NORMAL** = ``1`` .. _class_RenderingServer_constant_DECAL_TEXTURE_ORM: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_ORM** = ``2`` .. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_EMISSION** = ``3`` .. _class_RenderingServer_constant_DECAL_TEXTURE_MAX: .. rst-class:: classref-enumeration-constant :ref:`DecalTexture` **DECAL_TEXTURE_MAX** = ``4`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_DecalFilter: .. rst-class:: classref-enumeration enum **DecalFilter**: .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_NEAREST** = ``0`` Nearest-neighbor filter for decals (use for pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_LINEAR** = ``1`` Linear filter for decals (use for non-pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_NEAREST_MIPMAPS** = ``2`` Nearest-neighbor filter for decals (use for pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_LINEAR_MIPMAPS** = ``3`` Linear filter for decals (use for non-pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4`` Nearest-neighbor filter for decals (use for pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`DecalFilter` **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5`` Linear filter for decals (use for non-pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level`. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_VoxelGIQuality: .. rst-class:: classref-enumeration enum **VoxelGIQuality**: .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`VoxelGIQuality` **VOXEL_GI_QUALITY_LOW** = ``0`` .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`VoxelGIQuality` **VOXEL_GI_QUALITY_HIGH** = ``1`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesMode: .. rst-class:: classref-enumeration enum **ParticlesMode**: .. _class_RenderingServer_constant_PARTICLES_MODE_2D: .. rst-class:: classref-enumeration-constant :ref:`ParticlesMode` **PARTICLES_MODE_2D** = ``0`` .. _class_RenderingServer_constant_PARTICLES_MODE_3D: .. rst-class:: classref-enumeration-constant :ref:`ParticlesMode` **PARTICLES_MODE_3D** = ``1`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesTransformAlign: .. rst-class:: classref-enumeration enum **ParticlesTransformAlign**: .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ParticlesTransformAlign` **PARTICLES_TRANSFORM_ALIGN_DISABLED** = ``0`` .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD: .. rst-class:: classref-enumeration-constant :ref:`ParticlesTransformAlign` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = ``1`` .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`ParticlesTransformAlign` **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = ``2`` .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`ParticlesTransformAlign` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = ``3`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesDrawOrder: .. rst-class:: classref-enumeration enum **ParticlesDrawOrder**: .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX: .. rst-class:: classref-enumeration-constant :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_INDEX** = ``0`` Draw particles in the order that they appear in the particles array. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME: .. rst-class:: classref-enumeration-constant :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1`` Sort particles based on their lifetime. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME: .. rst-class:: classref-enumeration-constant :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2`` .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH: .. rst-class:: classref-enumeration-constant :ref:`ParticlesDrawOrder` **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = ``3`` Sort particles based on their distance to the camera. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesCollisionType: .. rst-class:: classref-enumeration enum **ParticlesCollisionType**: .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = ``0`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = ``1`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = ``2`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = ``3`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = ``4`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = ``5`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionType` **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = ``6`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution: .. rst-class:: classref-enumeration enum **ParticlesCollisionHeightfieldResolution**: .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = ``0`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = ``1`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = ``2`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = ``3`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = ``4`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = ``5`` .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX: .. rst-class:: classref-enumeration-constant :ref:`ParticlesCollisionHeightfieldResolution` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = ``6`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_FogVolumeShape: .. rst-class:: classref-enumeration enum **FogVolumeShape**: .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_ELLIPSOID** = ``0`` :ref:`FogVolume` will be shaped like an ellipsoid (stretched sphere). .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_CONE** = ``1`` :ref:`FogVolume` will be shaped like a cone pointing upwards (in local coordinates). The cone's angle is set automatically to fill the size. The cone will be adjusted to fit within the size. Rotate the :ref:`FogVolume` node to reorient the cone. Non-uniform scaling via size is not supported (scale the :ref:`FogVolume` node instead). .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_CYLINDER** = ``2`` :ref:`FogVolume` will be shaped like an upright cylinder (in local coordinates). Rotate the :ref:`FogVolume` node to reorient the cylinder. The cylinder will be adjusted to fit within the size. Non-uniform scaling via size is not supported (scale the :ref:`FogVolume` node instead). .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_BOX** = ``3`` :ref:`FogVolume` will be shaped like a box. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_WORLD** = ``4`` :ref:`FogVolume` will have no shape, will cover the whole world and will not be culled. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`FogVolumeShape` **FOG_VOLUME_SHAPE_MAX** = ``5`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportScaling3DMode: .. rst-class:: classref-enumeration enum **ViewportScaling3DMode**: .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0`` Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.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. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1`` Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.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 downsampling will be used instead. A value of ``1.0`` disables scaling. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportScaling3DMode` **VIEWPORT_SCALING_3D_MODE_MAX** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportUpdateMode: .. rst-class:: classref-enumeration enum **ViewportUpdateMode**: .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_DISABLED** = ``0`` Do not update the viewport. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_ONCE** = ``1`` Update the viewport once then set to disabled. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_WHEN_VISIBLE** = ``2`` Update the viewport whenever it is visible. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = ``3`` .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ViewportUpdateMode` **VIEWPORT_UPDATE_ALWAYS** = ``4`` Always update the viewport. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportClearMode: .. rst-class:: classref-enumeration enum **ViewportClearMode**: .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ViewportClearMode` **VIEWPORT_CLEAR_ALWAYS** = ``0`` The viewport is always cleared before drawing. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER: .. rst-class:: classref-enumeration-constant :ref:`ViewportClearMode` **VIEWPORT_CLEAR_NEVER** = ``1`` The viewport is never cleared before drawing. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportClearMode` **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = ``2`` The viewport is cleared once, then the clear mode is set to :ref:`VIEWPORT_CLEAR_NEVER`. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportEnvironmentMode: .. rst-class:: classref-enumeration enum **ViewportEnvironmentMode**: .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportEnvironmentMode` **VIEWPORT_ENVIRONMENT_DISABLED** = ``0`` Disable rendering of 3D environment over 2D canvas. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportEnvironmentMode` **VIEWPORT_ENVIRONMENT_ENABLED** = ``1`` Enable rendering of 3D environment over 2D canvas. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT: .. rst-class:: classref-enumeration-constant :ref:`ViewportEnvironmentMode` **VIEWPORT_ENVIRONMENT_INHERIT** = ``2`` Inherit enable/disable value from parent. If topmost parent is also set to inherit, then this has the same behavior as :ref:`VIEWPORT_ENVIRONMENT_ENABLED`. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportEnvironmentMode` **VIEWPORT_ENVIRONMENT_MAX** = ``3`` Max value of :ref:`ViewportEnvironmentMode` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportSDFOversize: .. rst-class:: classref-enumeration enum **ViewportSDFOversize**: .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = ``0`` .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = ``1`` .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = ``2`` .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = ``3`` .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFOversize` **VIEWPORT_SDF_OVERSIZE_MAX** = ``4`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportSDFScale: .. rst-class:: classref-enumeration enum **ViewportSDFScale**: .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFScale` **VIEWPORT_SDF_SCALE_100_PERCENT** = ``0`` .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFScale` **VIEWPORT_SDF_SCALE_50_PERCENT** = ``1`` .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFScale` **VIEWPORT_SDF_SCALE_25_PERCENT** = ``2`` .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportSDFScale` **VIEWPORT_SDF_SCALE_MAX** = ``3`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportMSAA: .. rst-class:: classref-enumeration enum **ViewportMSAA**: .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_DISABLED** = ``0`` Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting. .. _class_RenderingServer_constant_VIEWPORT_MSAA_2X: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_2X** = ``1`` Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance. .. _class_RenderingServer_constant_VIEWPORT_MSAA_4X: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_4X** = ``2`` Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance. .. _class_RenderingServer_constant_VIEWPORT_MSAA_8X: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **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. .. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportMSAA` **VIEWPORT_MSAA_MAX** = ``4`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportScreenSpaceAA: .. rst-class:: classref-enumeration enum **ViewportScreenSpaceAA**: .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = ``0`` .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA: .. rst-class:: classref-enumeration-constant :ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_FXAA** = ``1`` .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportScreenSpaceAA` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality: .. rst-class:: classref-enumeration enum **ViewportOcclusionCullingBuildQuality**: .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`ViewportOcclusionCullingBuildQuality` **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = ``0`` .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`ViewportOcclusionCullingBuildQuality` **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = ``1`` .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`ViewportOcclusionCullingBuildQuality` **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportRenderInfo: .. rst-class:: classref-enumeration enum **ViewportRenderInfo**: .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfo` **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = ``0`` Number of objects drawn in a single frame. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfo` **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1`` Number of vertices drawn in a single frame. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfo` **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2`` Number of draw calls during this frame. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfo` **VIEWPORT_RENDER_INFO_MAX** = ``3`` Represents the size of the :ref:`ViewportRenderInfo` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportRenderInfoType: .. rst-class:: classref-enumeration enum **ViewportRenderInfoType**: .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfoType` **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = ``0`` .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfoType` **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = ``1`` .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportRenderInfoType` **VIEWPORT_RENDER_INFO_TYPE_MAX** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportDebugDraw: .. rst-class:: classref-enumeration enum **ViewportDebugDraw**: .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_DISABLED** = ``0`` Debug draw is disabled. Default setting. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_UNSHADED** = ``1`` Objects are displayed without light information. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2`` Objects are displayed with only light information. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **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. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_WIREFRAME** = ``4`` Debug draw draws objects in wireframe. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **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. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6`` Objects are displayed with only the albedo value from :ref:`VoxelGI`\ s. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7`` Objects are displayed with only the lighting value from :ref:`VoxelGI`\ s. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8`` Objects are displayed with only the emission color from :ref:`VoxelGI`\ s. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = ``9`` Draws the shadow atlas that stores shadows from :ref:`OmniLight3D`\ s and :ref:`SpotLight3D`\ s in the upper left quadrant of the :ref:`Viewport`. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10`` Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D`\ s in the upper left quadrant of the :ref:`Viewport`. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = ``11`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **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` set in your :ref:`WorldEnvironment`. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **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` set in your :ref:`WorldEnvironment`. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14`` Colors each PSSM split for the :ref:`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. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = ``15`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SDFGI** = ``16`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = ``17`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = ``19`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = ``22`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = ``24`` .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS: .. rst-class:: classref-enumeration-constant :ref:`ViewportDebugDraw` **VIEWPORT_DEBUG_DRAW_MOTION_VECTORS** = ``25`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ViewportVRSMode: .. rst-class:: classref-enumeration enum **ViewportVRSMode**: .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSMode` **VIEWPORT_VRS_DISABLED** = ``0`` VRS is disabled. .. _class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSMode` **VIEWPORT_VRS_TEXTURE** = ``1`` VRS uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view. .. _class_RenderingServer_constant_VIEWPORT_VRS_XR: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSMode` **VIEWPORT_VRS_XR** = ``2`` VRS texture is supplied by the primary :ref:`XRInterface`. .. _class_RenderingServer_constant_VIEWPORT_VRS_MAX: .. rst-class:: classref-enumeration-constant :ref:`ViewportVRSMode` **VIEWPORT_VRS_MAX** = ``3`` Represents the size of the :ref:`ViewportVRSMode` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_SkyMode: .. rst-class:: classref-enumeration enum **SkyMode**: .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC: .. rst-class:: classref-enumeration-constant :ref:`SkyMode` **SKY_MODE_AUTOMATIC** = ``0`` .. _class_RenderingServer_constant_SKY_MODE_QUALITY: .. rst-class:: classref-enumeration-constant :ref:`SkyMode` **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` 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_RenderingServer_constant_SKY_MODE_INCREMENTAL: .. rst-class:: classref-enumeration-constant :ref:`SkyMode` **SKY_MODE_INCREMENTAL** = ``2`` .. _class_RenderingServer_constant_SKY_MODE_REALTIME: .. rst-class:: classref-enumeration-constant :ref:`SkyMode` **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` must be set to :ref:`Sky.RADIANCE_SIZE_256`. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentBG: .. rst-class:: classref-enumeration enum **EnvironmentBG**: .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_CLEAR_COLOR** = ``0`` Use the clear color as background. .. _class_RenderingServer_constant_ENV_BG_COLOR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_COLOR** = ``1`` Use a specified color as the background. .. _class_RenderingServer_constant_ENV_BG_SKY: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_SKY** = ``2`` Use a sky resource for the background. .. _class_RenderingServer_constant_ENV_BG_CANVAS: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **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. .. _class_RenderingServer_constant_ENV_BG_KEEP: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_KEEP** = ``4`` Do not clear the background, use whatever was rendered last frame as the background. .. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_CAMERA_FEED** = ``5`` Displays a camera feed in the background. .. _class_RenderingServer_constant_ENV_BG_MAX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBG` **ENV_BG_MAX** = ``6`` Represents the size of the :ref:`EnvironmentBG` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentAmbientSource: .. rst-class:: classref-enumeration enum **EnvironmentAmbientSource**: .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentAmbientSource` **ENV_AMBIENT_SOURCE_BG** = ``0`` Gather ambient light from whichever source is specified as the background. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentAmbientSource` **ENV_AMBIENT_SOURCE_DISABLED** = ``1`` Disable ambient light. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentAmbientSource` **ENV_AMBIENT_SOURCE_COLOR** = ``2`` Specify a specific :ref:`Color` for ambient light. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentAmbientSource` **ENV_AMBIENT_SOURCE_SKY** = ``3`` Gather ambient light from the :ref:`Sky` regardless of what the background is. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentReflectionSource: .. rst-class:: classref-enumeration enum **EnvironmentReflectionSource**: .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentReflectionSource` **ENV_REFLECTION_SOURCE_BG** = ``0`` Use the background for reflections. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentReflectionSource` **ENV_REFLECTION_SOURCE_DISABLED** = ``1`` Disable reflections. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentReflectionSource` **ENV_REFLECTION_SOURCE_SKY** = ``2`` Use the :ref:`Sky` for reflections regardless of what the background is. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentGlowBlendMode: .. rst-class:: classref-enumeration enum **EnvironmentGlowBlendMode**: .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **ENV_GLOW_BLEND_MODE_ADDITIVE** = ``0`` Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **ENV_GLOW_BLEND_MODE_SCREEN** = ``1`` Screen glow blending mode. Increases brightness, used frequently with bloom. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = ``2`` Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom). .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **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. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentGlowBlendMode` **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. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentToneMapper: .. rst-class:: classref-enumeration enum **EnvironmentToneMapper**: .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_LINEAR** = ``0`` Output color as they came in. This can cause bright lighting to look blown out, with noticeable clipping in the output colors. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_REINHARD** = ``1`` Use the Reinhard tonemapper. Performs a variation on rendered pixels' colors by this formula: ``color = color / (1 + color)``. This avoids clipping bright highlights, but the resulting image can look a bit dull. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_FILMIC** = ``2`` Use the filmic tonemapper. This avoids clipping bright highlights, with a resulting image that usually looks more vivid than :ref:`ENV_TONE_MAPPER_REINHARD`. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentToneMapper` **ENV_TONE_MAPPER_ACES** = ``3`` Use the Academy Color Encoding System tonemapper. ACES is slightly more expensive than other options, but it handles bright lighting in a more realistic fashion by desaturating it as it becomes brighter. ACES typically has a more contrasted output compared to :ref:`ENV_TONE_MAPPER_REINHARD` and :ref:`ENV_TONE_MAPPER_FILMIC`. \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSSRRoughnessQuality: .. rst-class:: classref-enumeration enum **EnvironmentSSRRoughnessQuality**: .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSRRoughnessQuality` **ENV_SSR_ROUGHNESS_QUALITY_DISABLED** = ``0`` Lowest quality of roughness filter for screen-space reflections. Rough materials will not have blurrier screen-space reflections compared to smooth (non-rough) materials. This is the fastest option. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSRRoughnessQuality` **ENV_SSR_ROUGHNESS_QUALITY_LOW** = ``1`` Low quality of roughness filter for screen-space reflections. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSRRoughnessQuality` **ENV_SSR_ROUGHNESS_QUALITY_MEDIUM** = ``2`` Medium quality of roughness filter for screen-space reflections. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSRRoughnessQuality` **ENV_SSR_ROUGHNESS_QUALITY_HIGH** = ``3`` High quality of roughness filter for screen-space reflections. This is the slowest option. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSSAOQuality: .. rst-class:: classref-enumeration enum **EnvironmentSSAOQuality**: .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_VERY_LOW** = ``0`` Lowest quality of screen-space ambient occlusion. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_LOW** = ``1`` Low quality screen-space ambient occlusion. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_MEDIUM** = ``2`` Medium quality screen-space ambient occlusion. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **ENV_SSAO_QUALITY_HIGH** = ``3`` High quality screen-space ambient occlusion. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSAOQuality` **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. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSSILQuality: .. rst-class:: classref-enumeration enum **EnvironmentSSILQuality**: .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_VERY_LOW** = ``0`` Lowest quality of screen-space indirect lighting. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_LOW** = ``1`` Low quality screen-space indirect lighting. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_MEDIUM** = ``2`` High quality screen-space indirect lighting. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **ENV_SSIL_QUALITY_HIGH** = ``3`` High quality screen-space indirect lighting. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSSILQuality` **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. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSDFGIYScale: .. rst-class:: classref-enumeration enum **EnvironmentSDFGIYScale**: .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIYScale` **ENV_SDFGI_Y_SCALE_50_PERCENT** = ``0`` .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIYScale` **ENV_SDFGI_Y_SCALE_75_PERCENT** = ``1`` .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIYScale` **ENV_SDFGI_Y_SCALE_100_PERCENT** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSDFGIRayCount: .. rst-class:: classref-enumeration enum **EnvironmentSDFGIRayCount**: .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_4** = ``0`` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_8** = ``1`` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_16** = ``2`` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_32** = ``3`` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_64** = ``4`` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_96** = ``5`` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_128** = ``6`` .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIRayCount` **ENV_SDFGI_RAY_COUNT_MAX** = ``7`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge: .. rst-class:: classref-enumeration enum **EnvironmentSDFGIFramesToConverge**: .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = ``0`` .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = ``1`` .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = ``2`` .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = ``3`` .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = ``4`` .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = ``5`` .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToConverge` **ENV_SDFGI_CONVERGE_MAX** = ``6`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight: .. rst-class:: classref-enumeration enum **EnvironmentSDFGIFramesToUpdateLight**: .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = ``0`` .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = ``1`` .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = ``2`` .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = ``3`` .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = ``4`` .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentSDFGIFramesToUpdateLight` **ENV_SDFGI_UPDATE_LIGHT_MAX** = ``5`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_SubSurfaceScatteringQuality: .. rst-class:: classref-enumeration enum **SubSurfaceScatteringQuality**: .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`SubSurfaceScatteringQuality` **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = ``0`` .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`SubSurfaceScatteringQuality` **SUB_SURFACE_SCATTERING_QUALITY_LOW** = ``1`` .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`SubSurfaceScatteringQuality` **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = ``2`` .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`SubSurfaceScatteringQuality` **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = ``3`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_DOFBokehShape: .. rst-class:: classref-enumeration enum **DOFBokehShape**: .. _class_RenderingServer_constant_DOF_BOKEH_BOX: .. rst-class:: classref-enumeration-constant :ref:`DOFBokehShape` **DOF_BOKEH_BOX** = ``0`` Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern. .. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON: .. rst-class:: classref-enumeration-constant :ref:`DOFBokehShape` **DOF_BOKEH_HEXAGON** = ``1`` Calculates DOF blur using a hexagon shaped filter. .. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE: .. rst-class:: classref-enumeration-constant :ref:`DOFBokehShape` **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). .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_DOFBlurQuality: .. rst-class:: classref-enumeration enum **DOFBlurQuality**: .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW: .. rst-class:: classref-enumeration-constant :ref:`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. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`DOFBlurQuality` **DOF_BLUR_QUALITY_LOW** = ``1`` Low quality DOF blur. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`DOFBlurQuality` **DOF_BLUR_QUALITY_MEDIUM** = ``2`` Medium quality DOF blur. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`DOFBlurQuality` **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. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_InstanceType: .. rst-class:: classref-enumeration enum **InstanceType**: .. _class_RenderingServer_constant_INSTANCE_NONE: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_NONE** = ``0`` The instance does not have a type. .. _class_RenderingServer_constant_INSTANCE_MESH: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_MESH** = ``1`` The instance is a mesh. .. _class_RenderingServer_constant_INSTANCE_MULTIMESH: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_MULTIMESH** = ``2`` The instance is a multimesh. .. _class_RenderingServer_constant_INSTANCE_PARTICLES: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_PARTICLES** = ``3`` The instance is a particle emitter. .. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_PARTICLES_COLLISION** = ``4`` .. _class_RenderingServer_constant_INSTANCE_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_LIGHT** = ``5`` The instance is a light. .. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_REFLECTION_PROBE** = ``6`` The instance is a reflection probe. .. _class_RenderingServer_constant_INSTANCE_DECAL: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_DECAL** = ``7`` The instance is a decal. .. _class_RenderingServer_constant_INSTANCE_VOXEL_GI: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_VOXEL_GI** = ``8`` The instance is a VoxelGI. .. _class_RenderingServer_constant_INSTANCE_LIGHTMAP: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_LIGHTMAP** = ``9`` The instance is a lightmap. .. _class_RenderingServer_constant_INSTANCE_OCCLUDER: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_OCCLUDER** = ``10`` .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_VISIBLITY_NOTIFIER** = ``11`` .. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_FOG_VOLUME** = ``12`` .. _class_RenderingServer_constant_INSTANCE_MAX: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_MAX** = ``13`` Represents the size of the :ref:`InstanceType` enum. .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK: .. rst-class:: classref-enumeration-constant :ref:`InstanceType` **INSTANCE_GEOMETRY_MASK** = ``14`` A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_InstanceFlags: .. rst-class:: classref-enumeration enum **InstanceFlags**: .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_USE_BAKED_LIGHT** = ``0`` Allows the instance to be used in baked lighting. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_USE_DYNAMIC_GI** = ``1`` Allows the instance to be used with dynamic global illumination. .. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = ``2`` When set, manually requests to draw geometry on next frame. .. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = ``3`` .. _class_RenderingServer_constant_INSTANCE_FLAG_MAX: .. rst-class:: classref-enumeration-constant :ref:`InstanceFlags` **INSTANCE_FLAG_MAX** = ``4`` Represents the size of the :ref:`InstanceFlags` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_ShadowCastingSetting: .. rst-class:: classref-enumeration enum **ShadowCastingSetting**: .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_OFF** = ``0`` Disable shadows from this instance. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_ON** = ``1`` Cast shadows from this instance. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **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. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3`` Only render the shadows from the object. The object itself will not be drawn. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_VisibilityRangeFadeMode: .. rst-class:: classref-enumeration enum **VisibilityRangeFadeMode**: .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_DISABLED** = ``0`` Disable visibility range fading for the given instance. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_SELF** = ``1`` Fade-out the given instance when it approaches its visibility range limits. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2`` Fade-in the given instance's dependencies when reaching its visibility range limits. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_BakeChannels: .. rst-class:: classref-enumeration enum **BakeChannels**: .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA: .. rst-class:: classref-enumeration-constant :ref:`BakeChannels` **BAKE_CHANNEL_ALBEDO_ALPHA** = ``0`` Index of :ref:`Image` in array of :ref:`Image`\ s returned by :ref:`bake_render_uv2`. Image uses :ref:`Image.FORMAT_RGBA8` and contains albedo color in the ``.rgb`` channels and alpha in the ``.a`` channel. .. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`BakeChannels` **BAKE_CHANNEL_NORMAL** = ``1`` Index of :ref:`Image` in array of :ref:`Image`\ s returned by :ref:`bake_render_uv2`. Image uses :ref:`Image.FORMAT_RGBA8` and contains the per-pixel normal of the object in the ``.rgb`` channels and nothing in the ``.a`` channel. The per-pixel normal is encoded as ``normal * 0.5 + 0.5``. .. _class_RenderingServer_constant_BAKE_CHANNEL_ORM: .. rst-class:: classref-enumeration-constant :ref:`BakeChannels` **BAKE_CHANNEL_ORM** = ``2`` Index of :ref:`Image` in array of :ref:`Image`\ s returned by :ref:`bake_render_uv2`. Image uses :ref:`Image.FORMAT_RGBA8` and contains ambient occlusion (from material and decals only) in the ``.r`` channel, roughness in the ``.g`` channel, metallic in the ``.b`` channel and sub surface scattering amount in the ``.a`` channel. .. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION: .. rst-class:: classref-enumeration-constant :ref:`BakeChannels` **BAKE_CHANNEL_EMISSION** = ``3`` Index of :ref:`Image` in array of :ref:`Image`\ s returned by :ref:`bake_render_uv2`. Image uses :ref:`Image.FORMAT_RGBAH` and contains emission color in the ``.rgb`` channels and nothing in the ``.a`` channel. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasTextureChannel: .. rst-class:: classref-enumeration enum **CanvasTextureChannel**: .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE: .. rst-class:: classref-enumeration-constant :ref:`CanvasTextureChannel` **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = ``0`` .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`CanvasTextureChannel` **CANVAS_TEXTURE_CHANNEL_NORMAL** = ``1`` .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR: .. rst-class:: classref-enumeration-constant :ref:`CanvasTextureChannel` **CANVAS_TEXTURE_CHANNEL_SPECULAR** = ``2`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_NinePatchAxisMode: .. rst-class:: classref-enumeration enum **NinePatchAxisMode**: .. _class_RenderingServer_constant_NINE_PATCH_STRETCH: .. rst-class:: classref-enumeration-constant :ref:`NinePatchAxisMode` **NINE_PATCH_STRETCH** = ``0`` The nine patch gets stretched where needed. .. _class_RenderingServer_constant_NINE_PATCH_TILE: .. rst-class:: classref-enumeration-constant :ref:`NinePatchAxisMode` **NINE_PATCH_TILE** = ``1`` The nine patch gets filled with tiles where needed. .. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT: .. rst-class:: classref-enumeration-constant :ref:`NinePatchAxisMode` **NINE_PATCH_TILE_FIT** = ``2`` The nine patch gets filled with tiles where needed and stretches them a bit if needed. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasItemTextureFilter: .. rst-class:: classref-enumeration enum **CanvasItemTextureFilter**: .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = ``0`` Uses the default filter mode for this :ref:`Viewport`. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **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. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **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. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3`` The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4`` The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5`` 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. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6`` 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. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureFilter` **CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``7`` Max value for :ref:`CanvasItemTextureFilter` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasItemTextureRepeat: .. rst-class:: classref-enumeration enum **CanvasItemTextureRepeat**: .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = ``0`` Uses the default repeat mode for this :ref:`Viewport`. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **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. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **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. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``3`` Flip the texture when repeating so that the edge lines up instead of abruptly changing. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX: .. rst-class:: classref-enumeration-constant :ref:`CanvasItemTextureRepeat` **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``4`` Max value for :ref:`CanvasItemTextureRepeat` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasGroupMode: .. rst-class:: classref-enumeration enum **CanvasGroupMode**: .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`CanvasGroupMode` **CANVAS_GROUP_MODE_DISABLED** = ``0`` .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_ONLY: .. rst-class:: classref-enumeration-constant :ref:`CanvasGroupMode` **CANVAS_GROUP_MODE_CLIP_ONLY** = ``1`` .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_AND_DRAW: .. rst-class:: classref-enumeration-constant :ref:`CanvasGroupMode` **CANVAS_GROUP_MODE_CLIP_AND_DRAW** = ``2`` .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT: .. rst-class:: classref-enumeration-constant :ref:`CanvasGroupMode` **CANVAS_GROUP_MODE_TRANSPARENT** = ``3`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasLightMode: .. rst-class:: classref-enumeration enum **CanvasLightMode**: .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightMode` **CANVAS_LIGHT_MODE_POINT** = ``0`` .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightMode` **CANVAS_LIGHT_MODE_DIRECTIONAL** = ``1`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasLightBlendMode: .. rst-class:: classref-enumeration enum **CanvasLightBlendMode**: .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightBlendMode` **CANVAS_LIGHT_BLEND_MODE_ADD** = ``0`` Adds light color additive to the canvas. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightBlendMode` **CANVAS_LIGHT_BLEND_MODE_SUB** = ``1`` Adds light color subtractive to the canvas. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightBlendMode` **CANVAS_LIGHT_BLEND_MODE_MIX** = ``2`` The light adds color depending on transparency. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasLightShadowFilter: .. rst-class:: classref-enumeration enum **CanvasLightShadowFilter**: .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightShadowFilter` **CANVAS_LIGHT_FILTER_NONE** = ``0`` Do not apply a filter to canvas light shadows. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightShadowFilter` **CANVAS_LIGHT_FILTER_PCF5** = ``1`` Use PCF5 filtering to filter canvas light shadows. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightShadowFilter` **CANVAS_LIGHT_FILTER_PCF13** = ``2`` Use PCF13 filtering to filter canvas light shadows. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX: .. rst-class:: classref-enumeration-constant :ref:`CanvasLightShadowFilter` **CANVAS_LIGHT_FILTER_MAX** = ``3`` Max value of the :ref:`CanvasLightShadowFilter` enum. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_CanvasOccluderPolygonCullMode: .. rst-class:: classref-enumeration enum **CanvasOccluderPolygonCullMode**: .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`CanvasOccluderPolygonCullMode` **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = ``0`` Culling of the canvas occluder is disabled. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE: .. rst-class:: classref-enumeration-constant :ref:`CanvasOccluderPolygonCullMode` **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = ``1`` Culling of the canvas occluder is clockwise. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE: .. rst-class:: classref-enumeration-constant :ref:`CanvasOccluderPolygonCullMode` **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = ``2`` Culling of the canvas occluder is counterclockwise. .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_GlobalShaderParameterType: .. rst-class:: classref-enumeration enum **GlobalShaderParameterType**: .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_BOOL** = ``0`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_BVEC2** = ``1`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_BVEC3** = ``2`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_BVEC4** = ``3`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_INT** = ``4`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_IVEC2** = ``5`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_IVEC3** = ``6`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_IVEC4** = ``7`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_RECT2I** = ``8`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_UINT** = ``9`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_UVEC2** = ``10`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_UVEC3** = ``11`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_UVEC4** = ``12`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_FLOAT** = ``13`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_VEC2** = ``14`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_VEC3** = ``15`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_VEC4** = ``16`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_COLOR** = ``17`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_RECT2** = ``18`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_MAT2** = ``19`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_MAT3** = ``20`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_MAT4** = ``21`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_TRANSFORM_2D** = ``22`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_TRANSFORM** = ``23`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLER2D** = ``24`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = ``25`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLER3D** = ``26`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_SAMPLERCUBE** = ``27`` .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`GlobalShaderParameterType` **GLOBAL_VAR_TYPE_MAX** = ``28`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_RenderingInfo: .. rst-class:: classref-enumeration enum **RenderingInfo**: .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = ``0`` .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = ``1`` .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = ``2`` .. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_TEXTURE_MEM_USED** = ``3`` .. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_BUFFER_MEM_USED** = ``4`` .. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED: .. rst-class:: classref-enumeration-constant :ref:`RenderingInfo` **RENDERING_INFO_VIDEO_MEM_USED** = ``5`` .. rst-class:: classref-item-separator ---- .. _enum_RenderingServer_Features: .. rst-class:: classref-enumeration enum **Features**: .. _class_RenderingServer_constant_FEATURE_SHADERS: .. rst-class:: classref-enumeration-constant :ref:`Features` **FEATURE_SHADERS** = ``0`` Hardware supports shaders. This enum is currently unused in Godot 3.x. .. _class_RenderingServer_constant_FEATURE_MULTITHREADED: .. rst-class:: classref-enumeration-constant :ref:`Features` **FEATURE_MULTITHREADED** = ``1`` Hardware supports multithreading. This enum is currently unused in Godot 3.x. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_RenderingServer_constant_NO_INDEX_ARRAY: .. rst-class:: classref-constant **NO_INDEX_ARRAY** = ``-1`` Marks an error that shows that the index array is empty. .. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE: .. rst-class:: classref-constant **ARRAY_WEIGHTS_SIZE** = ``4`` Number of weights/bones per vertex. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN: .. rst-class:: classref-constant **CANVAS_ITEM_Z_MIN** = ``-4096`` The minimum Z-layer for canvas items. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX: .. rst-class:: classref-constant **CANVAS_ITEM_Z_MAX** = ``4096`` The maximum Z-layer for canvas items. .. _class_RenderingServer_constant_MAX_GLOW_LEVELS: .. rst-class:: classref-constant **MAX_GLOW_LEVELS** = ``7`` Max number of glow levels that can be used with glow post-process effect. .. _class_RenderingServer_constant_MAX_CURSORS: .. rst-class:: classref-constant **MAX_CURSORS** = ``8`` Unused enum in Godot 3.x. .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS: .. rst-class:: classref-constant **MAX_2D_DIRECTIONAL_LIGHTS** = ``8`` .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN: .. rst-class:: classref-constant **MATERIAL_RENDER_PRIORITY_MIN** = ``-128`` The minimum renderpriority of all materials. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX: .. rst-class:: classref-constant **MATERIAL_RENDER_PRIORITY_MAX** = ``127`` The maximum renderpriority of all materials. .. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT: .. rst-class:: classref-constant **ARRAY_CUSTOM_COUNT** = ``4`` .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_POSITION** = ``1`` .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = ``2`` .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_VELOCITY** = ``4`` .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_COLOR** = ``8`` .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM: .. rst-class:: classref-constant **PARTICLES_EMIT_FLAG_CUSTOM** = ``16`` .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_RenderingServer_property_render_loop_enabled: .. rst-class:: classref-property :ref:`bool` **render_loop_enabled** .. rst-class:: classref-property-setget - void **set_render_loop_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_render_loop_enabled** **(** **)** If ``false``, disables rendering completely, but the engine logic is still being processed. You can call :ref:`force_draw` to draw a frame even with rendering disabled. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_RenderingServer_method_bake_render_uv2: .. rst-class:: classref-method :ref:`Image[]` **bake_render_uv2** **(** :ref:`RID` base, :ref:`RID[]` material_overrides, :ref:`Vector2i` image_size **)** Bakes the material data of the Mesh passed in the ``base`` parameter with optional ``material_overrides`` to a set of :ref:`Image`\ s of size ``image_size``. Returns an array of :ref:`Image`\ s containing material properties as specified in :ref:`BakeChannels`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_create: .. rst-class:: classref-method :ref:`RID` **camera_attributes_create** **(** **)** Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_attributes_`` RenderingServer functions. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_auto_exposure: .. rst-class:: classref-method void **camera_attributes_set_auto_exposure** **(** :ref:`RID` camera_attributes, :ref:`bool` enable, :ref:`float` min_sensitivity, :ref:`float` max_sensitivity, :ref:`float` speed, :ref:`float` scale **)** Sets the parameters to use with the auto-exposure effect. These parameters take on the same meaning as their counterparts in :ref:`CameraAttributes` and :ref:`CameraAttributesPractical`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur: .. rst-class:: classref-method void **camera_attributes_set_dof_blur** **(** :ref:`RID` camera_attributes, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** Sets the parameters to use with the DOF blur effect. These parameters take on the same meaning as their counterparts in :ref:`CameraAttributesPractical`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape: .. rst-class:: classref-method void **camera_attributes_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape` shape **)** Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve artistic effect, or to meet performance targets. For more detail on available options see :ref:`DOFBokehShape`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality: .. rst-class:: classref-method void **camera_attributes_set_dof_blur_quality** **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** Sets the quality level of the DOF blur effect to one of the options in :ref:`DOFBlurQuality`. ``use_jitter`` can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_attributes_set_exposure: .. rst-class:: classref-method void **camera_attributes_set_exposure** **(** :ref:`RID` camera_attributes, :ref:`float` multiplier, :ref:`float` normalization **)** Sets the exposure values that will be used by the renderers. The normalization amount is used to bake a given Exposure Value (EV) into rendering calculations to reduce the dynamic range of the scene. The normalization factor can be calculated from exposure value (EV100) as follows: :: func get_exposure_normalization(float ev100): return 1.0 / (pow(2.0, ev100) * 1.2) The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows: :: func get_exposure(float aperture, float shutter_speed, float sensitivity): return log2((aperture * aperture) / shutterSpeed * (100.0 / sensitivity)) .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_camera_attributes: .. rst-class:: classref-method void **camera_set_camera_attributes** **(** :ref:`RID` camera, :ref:`RID` effects **)** Sets the camera_attributes created with :ref:`camera_attributes_create` to the given camera. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_cull_mask: .. rst-class:: classref-method void **camera_set_cull_mask** **(** :ref:`RID` camera, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_environment: .. rst-class:: classref-method void **camera_set_environment** **(** :ref:`RID` camera, :ref:`RID` env **)** Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_frustum: .. rst-class:: classref-method void **camera_set_frustum** **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_orthogonal: .. rst-class:: classref-method void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_perspective: .. rst-class:: classref-method void **camera_set_perspective** **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_transform: .. rst-class:: classref-method void **camera_set_transform** **(** :ref:`RID` camera, :ref:`Transform3D` transform **)** Sets :ref:`Transform3D` of camera. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_camera_set_use_vertical_aspect: .. rst-class:: classref-method void **camera_set_use_vertical_aspect** **(** :ref:`RID` camera, :ref:`bool` enable **)** If ``true``, preserves the horizontal aspect ratio which is equivalent to :ref:`Camera3D.KEEP_WIDTH`. If ``false``, preserves the vertical aspect ratio which is equivalent to :ref:`Camera3D.KEEP_HEIGHT`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_create: .. rst-class:: classref-method :ref:`RID` **canvas_create** **(** **)** Creates a canvas and returns the assigned :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_animation_slice: .. rst-class:: classref-method void **canvas_item_add_animation_slice** **(** :ref:`RID` item, :ref:`float` animation_length, :ref:`float` slice_begin, :ref:`float` slice_end, :ref:`float` offset=0.0 **)** Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_circle: .. rst-class:: classref-method void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** Draws a circle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_circle`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_clip_ignore: .. rst-class:: classref-method void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to false. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region: .. rst-class:: classref-method void **canvas_item_add_lcd_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate **)** See also :ref:`CanvasItem.draw_lcd_texture_rect_region`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_line: .. rst-class:: classref-method void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** Draws a line on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_line`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_mesh: .. rst-class:: classref-method void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`RID` texture **)** Draws a mesh created with :ref:`mesh_create` with given ``transform``, ``modulate`` color, and ``texture``. This is used internally by :ref:`MeshInstance2D`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region: .. rst-class:: classref-method void **canvas_item_add_msdf_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`float` px_range=1.0, :ref:`float` scale=1.0 **)** See also :ref:`CanvasItem.draw_msdf_texture_rect_region`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_multimesh: .. rst-class:: classref-method void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture **)** Draws a 2D :ref:`MultiMesh` on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_multimesh`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_nine_patch: .. rst-class:: classref-method void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** Draws a nine-patch rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_particles: .. rst-class:: classref-method void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture **)** Draws particles on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_polygon: .. rst-class:: classref-method void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`RID` texture **)** Draws a 2D polygon on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_polygon`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_polyline: .. rst-class:: classref-method void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=-1.0, :ref:`bool` antialiased=false **)** Draws a 2D polyline on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_polyline`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_primitive: .. rst-class:: classref-method void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`RID` texture **)** Draws a 2D primitive on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_primitive`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_rect: .. rst-class:: classref-method void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** Draws a rectangle on the :ref:`CanvasItem` pointed to by the ``item`` :ref:`RID`. See also :ref:`CanvasItem.draw_rect`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_set_transform: .. rst-class:: classref-method void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** Sets a :ref:`Transform2D` that will be used to transform subsequent canvas item commands. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_texture_rect: .. rst-class:: classref-method void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_texture_rect_region: .. rst-class:: classref-method void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_add_triangle_array: .. rst-class:: classref-method void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PackedInt32Array` indices, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedInt32Array` bones=PackedInt32Array(), :ref:`PackedFloat32Array` weights=PackedFloat32Array(), :ref:`RID` texture, :ref:`int` count=-1 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_clear: .. rst-class:: classref-method void **canvas_item_clear** **(** :ref:`RID` item **)** Clears the :ref:`CanvasItem` and removes all commands in it. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_create: .. rst-class:: classref-method :ref:`RID` **canvas_item_create** **(** **)** Creates a new :ref:`CanvasItem` instance and returns its :ref:`RID`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode: .. rst-class:: classref-method void **canvas_item_set_canvas_group_mode** **(** :ref:`RID` item, :ref:`CanvasGroupMode` mode, :ref:`float` clear_margin=5.0, :ref:`bool` fit_empty=false, :ref:`float` fit_margin=0.0, :ref:`bool` blur_mipmaps=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_clip: .. rst-class:: classref-method void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer: .. rst-class:: classref-method void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_custom_rect: .. rst-class:: classref-method void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_default_texture_filter: .. rst-class:: classref-method void **canvas_item_set_default_texture_filter** **(** :ref:`RID` item, :ref:`CanvasItemTextureFilter` filter **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat: .. rst-class:: classref-method void **canvas_item_set_default_texture_repeat** **(** :ref:`RID` item, :ref:`CanvasItemTextureRepeat` repeat **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_distance_field_mode: .. rst-class:: classref-method void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent: .. rst-class:: classref-method void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_draw_index: .. rst-class:: classref-method void **canvas_item_set_draw_index** **(** :ref:`RID` item, :ref:`int` index **)** Sets the index for the :ref:`CanvasItem`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_light_mask: .. rst-class:: classref-method void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_material: .. rst-class:: classref-method void **canvas_item_set_material** **(** :ref:`RID` item, :ref:`RID` material **)** Sets a new material to the :ref:`CanvasItem`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_modulate: .. rst-class:: classref-method void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_parent: .. rst-class:: classref-method void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_self_modulate: .. rst-class:: classref-method void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y: .. rst-class:: classref-method void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_transform: .. rst-class:: classref-method void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_use_parent_material: .. rst-class:: classref-method void **canvas_item_set_use_parent_material** **(** :ref:`RID` item, :ref:`bool` enabled **)** Sets if the :ref:`CanvasItem` uses its parent's material. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_visibility_layer: .. rst-class:: classref-method void **canvas_item_set_visibility_layer** **(** :ref:`RID` item, :ref:`int` visibility_layer **)** Sets the rendering visibility layer associated with this :ref:`CanvasItem`. Only :ref:`Viewport` nodes with a matching rendering mask will render this :ref:`CanvasItem`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_visibility_notifier: .. rst-class:: classref-method void **canvas_item_set_visibility_notifier** **(** :ref:`RID` item, :ref:`bool` enable, :ref:`Rect2` area, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_visible: .. rst-class:: classref-method void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent: .. rst-class:: classref-method void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** If this is enabled, the Z index of the parent will be added to the children's Z index. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_item_set_z_index: .. rst-class:: classref-method void **canvas_item_set_z_index** **(** :ref:`RID` item, :ref:`int` z_index **)** Sets the :ref:`CanvasItem`'s Z index, i.e. its draw order (lower indexes are drawn first). .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_attach_to_canvas: .. rst-class:: classref-method void **canvas_light_attach_to_canvas** **(** :ref:`RID` light, :ref:`RID` canvas **)** Attaches the canvas light to the canvas. Removes it from its previous canvas. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas: .. rst-class:: classref-method void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID` occluder, :ref:`RID` canvas **)** Attaches a light occluder to the canvas. Removes it from its previous canvas. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision: .. rst-class:: classref-method void **canvas_light_occluder_set_as_sdf_collision** **(** :ref:`RID` occluder, :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_enabled: .. rst-class:: classref-method void **canvas_light_occluder_set_enabled** **(** :ref:`RID` occluder, :ref:`bool` enabled **)** Enables or disables light occluder. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_light_mask: .. rst-class:: classref-method void **canvas_light_occluder_set_light_mask** **(** :ref:`RID` occluder, :ref:`int` mask **)** The light mask. See :ref:`LightOccluder2D` for more information on light masks. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_polygon: .. rst-class:: classref-method void **canvas_light_occluder_set_polygon** **(** :ref:`RID` occluder, :ref:`RID` polygon **)** Sets a light occluder's polygon. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_occluder_set_transform: .. rst-class:: classref-method void **canvas_light_occluder_set_transform** **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** Sets a light occluder's :ref:`Transform2D`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_blend_mode: .. rst-class:: classref-method void **canvas_light_set_blend_mode** **(** :ref:`RID` light, :ref:`CanvasLightBlendMode` mode **)** Sets the blend mode for the given canvas light. See :ref:`CanvasLightBlendMode` for options. Equivalent to :ref:`Light2D.blend_mode`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_color: .. rst-class:: classref-method void **canvas_light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color for a light. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_enabled: .. rst-class:: classref-method void **canvas_light_set_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables a canvas light. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_energy: .. rst-class:: classref-method void **canvas_light_set_energy** **(** :ref:`RID` light, :ref:`float` energy **)** Sets a canvas light's energy. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_height: .. rst-class:: classref-method void **canvas_light_set_height** **(** :ref:`RID` light, :ref:`float` height **)** Sets a canvas light's height. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_item_cull_mask: .. rst-class:: classref-method void **canvas_light_set_item_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** The light mask. See :ref:`LightOccluder2D` for more information on light masks. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask: .. rst-class:: classref-method void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** The binary mask used to determine which layers this canvas light's shadows affects. See :ref:`LightOccluder2D` for more information on light masks. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_layer_range: .. rst-class:: classref-method void **canvas_light_set_layer_range** **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** The layer range that gets rendered with this light. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_mode: .. rst-class:: classref-method void **canvas_light_set_mode** **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** The mode of the light, see :ref:`CanvasLightMode` constants. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_shadow_color: .. rst-class:: classref-method void **canvas_light_set_shadow_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color of the canvas light's shadow. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_shadow_enabled: .. rst-class:: classref-method void **canvas_light_set_shadow_enabled** **(** :ref:`RID` light, :ref:`bool` enabled **)** Enables or disables the canvas light's shadow. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_shadow_filter: .. rst-class:: classref-method void **canvas_light_set_shadow_filter** **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter` constants. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_shadow_smooth: .. rst-class:: classref-method void **canvas_light_set_shadow_smooth** **(** :ref:`RID` light, :ref:`float` smooth **)** Smoothens the shadow. The lower, the smoother. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_texture: .. rst-class:: classref-method void **canvas_light_set_texture** **(** :ref:`RID` light, :ref:`RID` texture **)** Sets the texture to be used by a :ref:`PointLight2D`. Equivalent to :ref:`PointLight2D.texture`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_texture_offset: .. rst-class:: classref-method void **canvas_light_set_texture_offset** **(** :ref:`RID` light, :ref:`Vector2` offset **)** Sets the offset of a :ref:`PointLight2D`'s texture. Equivalent to :ref:`PointLight2D.offset`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_texture_scale: .. rst-class:: classref-method void **canvas_light_set_texture_scale** **(** :ref:`RID` light, :ref:`float` scale **)** Sets the scale factor of a :ref:`PointLight2D`'s texture. Equivalent to :ref:`PointLight2D.texture_scale`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_transform: .. rst-class:: classref-method void **canvas_light_set_transform** **(** :ref:`RID` light, :ref:`Transform2D` transform **)** Sets the canvas light's :ref:`Transform2D`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_light_set_z_range: .. rst-class:: classref-method void **canvas_light_set_z_range** **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** Sets the Z range of objects that will be affected by this light. Equivalent to :ref:`Light2D.range_z_min` and :ref:`Light2D.range_z_max`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_occluder_polygon_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode: .. rst-class:: classref-method void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode` constants. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_occluder_polygon_set_shape: .. rst-class:: classref-method void **canvas_occluder_polygon_set_shape** **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape, :ref:`bool` closed **)** Sets the shape of the occluder polygon. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_disable_scale: .. rst-class:: classref-method void **canvas_set_disable_scale** **(** :ref:`bool` disable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_item_mirroring: .. rst-class:: classref-method void **canvas_set_item_mirroring** **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_modulate: .. rst-class:: classref-method void **canvas_set_modulate** **(** :ref:`RID` canvas, :ref:`Color` color **)** Modulates all colors in the given canvas. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_set_shadow_texture_size: .. rst-class:: classref-method void **canvas_set_shadow_texture_size** **(** :ref:`int` size **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_create: .. rst-class:: classref-method :ref:`RID` **canvas_texture_create** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_set_channel: .. rst-class:: classref-method void **canvas_texture_set_channel** **(** :ref:`RID` canvas_texture, :ref:`CanvasTextureChannel` channel, :ref:`RID` texture **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_set_shading_parameters: .. rst-class:: classref-method void **canvas_texture_set_shading_parameters** **(** :ref:`RID` canvas_texture, :ref:`Color` base_color, :ref:`float` shininess **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_set_texture_filter: .. rst-class:: classref-method void **canvas_texture_set_texture_filter** **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureFilter` filter **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_canvas_texture_set_texture_repeat: .. rst-class:: classref-method void **canvas_texture_set_texture_repeat** **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureRepeat` repeat **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_create_local_rendering_device: .. rst-class:: classref-method :ref:`RenderingDevice` **create_local_rendering_device** **(** **)** |const| Creates a RenderingDevice that can be used to do draw and compute operations on a separate thread. Cannot draw to the screen nor share data with the global RenderingDevice. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_create: .. rst-class:: classref-method :ref:`RID` **decal_create** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_albedo_mix: .. rst-class:: classref-method void **decal_set_albedo_mix** **(** :ref:`RID` decal, :ref:`float` albedo_mix **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_cull_mask: .. rst-class:: classref-method void **decal_set_cull_mask** **(** :ref:`RID` decal, :ref:`int` mask **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_distance_fade: .. rst-class:: classref-method void **decal_set_distance_fade** **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` length **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_emission_energy: .. rst-class:: classref-method void **decal_set_emission_energy** **(** :ref:`RID` decal, :ref:`float` energy **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_fade: .. rst-class:: classref-method void **decal_set_fade** **(** :ref:`RID` decal, :ref:`float` above, :ref:`float` below **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_modulate: .. rst-class:: classref-method void **decal_set_modulate** **(** :ref:`RID` decal, :ref:`Color` color **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_normal_fade: .. rst-class:: classref-method void **decal_set_normal_fade** **(** :ref:`RID` decal, :ref:`float` fade **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_size: .. rst-class:: classref-method void **decal_set_size** **(** :ref:`RID` decal, :ref:`Vector3` size **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decal_set_texture: .. rst-class:: classref-method void **decal_set_texture** **(** :ref:`RID` decal, :ref:`DecalTexture` type, :ref:`RID` texture **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_decals_set_filter: .. rst-class:: classref-method void **decals_set_filter** **(** :ref:`DecalFilter` filter **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_directional_light_create: .. rst-class:: classref-method :ref:`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` static method. To place in a scene, attach this directional light to an instance using :ref:`instance_set_base` using the returned RID. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_directional_shadow_atlas_set_size: .. rst-class:: classref-method void **directional_shadow_atlas_set_size** **(** :ref:`int` size, :ref:`bool` is_16bits **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality: .. rst-class:: classref-method void **directional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality` quality **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_bake_panorama: .. rst-class:: classref-method :ref:`Image` **environment_bake_panorama** **(** :ref:`RID` environment, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale: .. rst-class:: classref-method void **environment_glow_set_use_bicubic_upscale** **(** :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_adjustment: .. rst-class:: classref-method void **environment_set_adjustment** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`bool` use_1d_color_correction, :ref:`RID` color_correction **)** Sets the values to be used with the "Adjustment" post-process effect. See :ref:`Environment` for more details. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ambient_light: .. rst-class:: classref-method void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_background: .. rst-class:: classref-method void **environment_set_background** **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** Sets the *BGMode* of the environment. Equivalent to :ref:`Environment.background_mode`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_bg_color: .. rst-class:: classref-method void **environment_set_bg_color** **(** :ref:`RID` env, :ref:`Color` color **)** Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_bg_energy: .. rst-class:: classref-method void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` multiplier, :ref:`float` exposure_value **)** Sets the intensity of the background color. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_canvas_max_layer: .. rst-class:: classref-method void **environment_set_canvas_max_layer** **(** :ref:`RID` env, :ref:`int` max_layer **)** Sets the maximum layer to use if using Canvas background mode. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_fog: .. rst-class:: classref-method void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective, :ref:`float` sky_affect **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_glow: .. rst-class:: classref-method void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`PackedFloat32Array` levels, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`float` glow_map_strength, :ref:`RID` glow_map **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sdfgi: .. rst-class:: classref-method void **environment_set_sdfgi** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` cascades, :ref:`float` min_cell_size, :ref:`EnvironmentSDFGIYScale` y_scale, :ref:`bool` use_occlusion, :ref:`float` bounce_feedback, :ref:`bool` read_sky, :ref:`float` energy, :ref:`float` normal_bias, :ref:`float` probe_bias **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge: .. rst-class:: classref-method void **environment_set_sdfgi_frames_to_converge** **(** :ref:`EnvironmentSDFGIFramesToConverge` frames **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light: .. rst-class:: classref-method void **environment_set_sdfgi_frames_to_update_light** **(** :ref:`EnvironmentSDFGIFramesToUpdateLight` frames **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sdfgi_ray_count: .. rst-class:: classref-method void **environment_set_sdfgi_ray_count** **(** :ref:`EnvironmentSDFGIRayCount` ray_count **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sky: .. rst-class:: classref-method void **environment_set_sky** **(** :ref:`RID` env, :ref:`RID` sky **)** Sets the :ref:`Sky` to be used as the environment's background when using *BGMode* sky. Equivalent to :ref:`Environment.sky`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sky_custom_fov: .. rst-class:: classref-method void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** Sets a custom field of view for the background :ref:`Sky`. Equivalent to :ref:`Environment.sky_custom_fov`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_sky_orientation: .. rst-class:: classref-method void **environment_set_sky_orientation** **(** :ref:`RID` env, :ref:`Basis` orientation **)** Sets the rotation of the background :ref:`Sky` expressed as a :ref:`Basis`. Equivalent to :ref:`Environment.sky_rotation`, where the rotation vector is used to construct the :ref:`Basis`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssao: .. rst-class:: classref-method void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` power, :ref:`float` detail, :ref:`float` horizon, :ref:`float` sharpness, :ref:`float` light_affect, :ref:`float` ao_channel_affect **)** Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment` for more details. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssao_quality: .. rst-class:: classref-method void **environment_set_ssao_quality** **(** :ref:`EnvironmentSSAOQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment` for more details. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssil_quality: .. rst-class:: classref-method void **environment_set_ssil_quality** **(** :ref:`EnvironmentSSILQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment` for more details. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssr: .. rst-class:: classref-method void **environment_set_ssr** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance **)** Sets the variables to be used with the "screen space reflections" post-process effect. See :ref:`Environment` for more details. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_ssr_roughness_quality: .. rst-class:: classref-method void **environment_set_ssr_roughness_quality** **(** :ref:`EnvironmentSSRRoughnessQuality` quality **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_tonemap: .. rst-class:: classref-method void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white **)** Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment` for more details. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_volumetric_fog: .. rst-class:: classref-method void **environment_set_volumetric_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject, :ref:`float` sky_affect **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active: .. rst-class:: classref-method void **environment_set_volumetric_fog_filter_active** **(** :ref:`bool` active **)** Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size: .. rst-class:: classref-method void **environment_set_volumetric_fog_volume_size** **(** :ref:`int` size, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_fog_volume_create: .. rst-class:: classref-method :ref:`RID` **fog_volume_create** **(** **)** Creates a new fog volume and allocates an RID. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_fog_volume_set_material: .. rst-class:: classref-method void **fog_volume_set_material** **(** :ref:`RID` fog_volume, :ref:`RID` material **)** Sets the :ref:`Material` of the fog volume. Can be either a :ref:`FogMaterial` or a custom :ref:`ShaderMaterial`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_fog_volume_set_shape: .. rst-class:: classref-method void **fog_volume_set_shape** **(** :ref:`RID` fog_volume, :ref:`FogVolumeShape` shape **)** Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`FOG_VOLUME_SHAPE_CONE`, :ref:`FOG_VOLUME_SHAPE_CYLINDER`, :ref:`FOG_VOLUME_SHAPE_BOX` or :ref:`FOG_VOLUME_SHAPE_WORLD`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_fog_volume_set_size: .. rst-class:: classref-method void **fog_volume_set_size** **(** :ref:`RID` fog_volume, :ref:`Vector3` size **)** Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID`, :ref:`FOG_VOLUME_SHAPE_CONE`, :ref:`FOG_VOLUME_SHAPE_CYLINDER` or :ref:`FOG_VOLUME_SHAPE_BOX`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_force_draw: .. rst-class:: classref-method void **force_draw** **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_force_sync: .. rst-class:: classref-method void **force_sync** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_free_rid: .. rst-class:: classref-method void **free_rid** **(** :ref:`RID` rid **)** Tries to free an object in the RenderingServer. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_default_clear_color: .. rst-class:: classref-method :ref:`Color` **get_default_clear_color** **(** **)** Returns the default clear color which is used when a specific clear color has not been selected. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_frame_setup_time_cpu: .. rst-class:: classref-method :ref:`float` **get_frame_setup_time_cpu** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_rendering_device: .. rst-class:: classref-method :ref:`RenderingDevice` **get_rendering_device** **(** **)** |const| Returns the global RenderingDevice. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_rendering_info: .. rst-class:: classref-method :ref:`int` **get_rendering_info** **(** :ref:`RenderingInfo` info **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_shader_parameter_list: .. rst-class:: classref-method :ref:`Dictionary[]` **get_shader_parameter_list** **(** :ref:`RID` shader **)** |const| Returns the parameters of a shader. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_test_cube: .. rst-class:: classref-method :ref:`RID` **get_test_cube** **(** **)** Returns the ID of the test cube. Creates one if none exists. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_test_texture: .. rst-class:: classref-method :ref:`RID` **get_test_texture** **(** **)** Returns the ID of the test texture. Creates one if none exists. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_video_adapter_api_version: .. rst-class:: classref-method :ref:`String` **get_video_adapter_api_version** **(** **)** |const| Returns the version of the graphics video adapter *currently in use* (e.g. "1.2.189" for Vulkan, "3.3.0 NVIDIA 510.60.02" for OpenGL). This version may be different from the actual latest version supported by the hardware, as Godot may not always request the latest version. \ **Note:** When running a headless or server binary, this function returns an empty string. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_video_adapter_name: .. rst-class:: classref-method :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_video_adapter_type: .. rst-class:: classref-method :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_video_adapter_vendor: .. rst-class:: classref-method :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_get_white_texture: .. rst-class:: classref-method :ref:`RID` **get_white_texture** **(** **)** Returns the ID of a white texture. Creates one if none exists. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_gi_set_use_half_resolution: .. rst-class:: classref-method void **gi_set_use_half_resolution** **(** :ref:`bool` half_resolution **)** If ``half_resolution`` is ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment.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` rendering is not affected by this setting. See also :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_add: .. rst-class:: classref-method void **global_shader_parameter_add** **(** :ref:`StringName` name, :ref:`GlobalShaderParameterType` type, :ref:`Variant` default_value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_get: .. rst-class:: classref-method :ref:`Variant` **global_shader_parameter_get** **(** :ref:`StringName` name **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_get_list: .. rst-class:: classref-method :ref:`PackedStringArray` **global_shader_parameter_get_list** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_get_type: .. rst-class:: classref-method :ref:`GlobalShaderParameterType` **global_shader_parameter_get_type** **(** :ref:`StringName` name **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_remove: .. rst-class:: classref-method void **global_shader_parameter_remove** **(** :ref:`StringName` name **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_set: .. rst-class:: classref-method void **global_shader_parameter_set** **(** :ref:`StringName` name, :ref:`Variant` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_global_shader_parameter_set_override: .. rst-class:: classref-method void **global_shader_parameter_set_override** **(** :ref:`StringName` name, :ref:`Variant` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_has_changed: .. rst-class:: classref-method :ref:`bool` **has_changed** **(** **)** |const| Returns ``true`` if changes have been made to the RenderingServer's data. :ref:`force_draw` is usually called if this happens. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_has_feature: .. rst-class:: classref-method :ref:`bool` **has_feature** **(** :ref:`Features` feature **)** |const| Not yet implemented. Always returns ``false``. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_has_os_feature: .. rst-class:: classref-method :ref:`bool` **has_os_feature** **(** :ref:`String` feature **)** |const| Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_attach_object_instance_id: .. rst-class:: classref-method void **instance_attach_object_instance_id** **(** :ref:`RID` instance, :ref:`int` id **)** Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with :ref:`instances_cull_aabb`, :ref:`instances_cull_convex`, and :ref:`instances_cull_ray`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_attach_skeleton: .. rst-class:: classref-method void **instance_attach_skeleton** **(** :ref:`RID` instance, :ref:`RID` skeleton **)** Attaches a skeleton to an instance. Removes the previous skeleton from the instance. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_create: .. rst-class:: classref-method :ref:`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` 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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_create2: .. rst-class:: classref-method :ref:`RID` **instance_create2** **(** :ref:`RID` base, :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter: .. rst-class:: classref-method :ref:`Variant` **instance_geometry_get_shader_parameter** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value: .. rst-class:: classref-method :ref:`Variant` **instance_geometry_get_shader_parameter_default_value** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list: .. rst-class:: classref-method :ref:`Dictionary[]` **instance_geometry_get_shader_parameter_list** **(** :ref:`RID` instance **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting: .. rst-class:: classref-method void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** Sets the shadow casting setting to one of :ref:`ShadowCastingSetting`. Equivalent to :ref:`GeometryInstance3D.cast_shadow`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_flag: .. rst-class:: classref-method void **instance_geometry_set_flag** **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** Sets the flag for a given :ref:`InstanceFlags`. See :ref:`InstanceFlags` for more details. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_lightmap: .. rst-class:: classref-method void **instance_geometry_set_lightmap** **(** :ref:`RID` instance, :ref:`RID` lightmap, :ref:`Rect2` lightmap_uv_scale, :ref:`int` lightmap_slice **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_lod_bias: .. rst-class:: classref-method void **instance_geometry_set_lod_bias** **(** :ref:`RID` instance, :ref:`float` lod_bias **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_material_overlay: .. rst-class:: classref-method void **instance_geometry_set_material_overlay** **(** :ref:`RID` instance, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_material_override: .. rst-class:: classref-method void **instance_geometry_set_material_override** **(** :ref:`RID` instance, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_shader_parameter: .. rst-class:: classref-method void **instance_geometry_set_shader_parameter** **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_transparency: .. rst-class:: classref-method void **instance_geometry_set_transparency** **(** :ref:`RID` instance, :ref:`float` transparency **)** Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_geometry_set_visibility_range: .. rst-class:: classref-method void **instance_geometry_set_visibility_range** **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin, :ref:`VisibilityRangeFadeMode` fade_mode **)** Sets the visibility range values for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.visibility_range_begin` and related properties. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_base: .. rst-class:: classref-method void **instance_set_base** **(** :ref:`RID` instance, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_blend_shape_weight: .. rst-class:: classref-method void **instance_set_blend_shape_weight** **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** Sets the weight for a given blend shape associated with this instance. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_custom_aabb: .. rst-class:: classref-method void **instance_set_custom_aabb** **(** :ref:`RID` instance, :ref:`AABB` aabb **)** Sets a custom AABB to use when culling objects from the view frustum. Equivalent to setting :ref:`GeometryInstance3D.custom_aabb`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_extra_visibility_margin: .. rst-class:: classref-method void **instance_set_extra_visibility_margin** **(** :ref:`RID` instance, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_ignore_culling: .. rst-class:: classref-method void **instance_set_ignore_culling** **(** :ref:`RID` instance, :ref:`bool` enabled **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_layer_mask: .. rst-class:: classref-method void **instance_set_layer_mask** **(** :ref:`RID` instance, :ref:`int` mask **)** Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_pivot_data: .. rst-class:: classref-method void **instance_set_pivot_data** **(** :ref:`RID` instance, :ref:`float` sorting_offset, :ref:`bool` use_aabb_center **)** Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_scenario: .. rst-class:: classref-method void **instance_set_scenario** **(** :ref:`RID` instance, :ref:`RID` scenario **)** Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_surface_override_material: .. rst-class:: classref-method void **instance_set_surface_override_material** **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_transform: .. rst-class:: classref-method void **instance_set_transform** **(** :ref:`RID` instance, :ref:`Transform3D` transform **)** Sets the world space transform of the instance. Equivalent to :ref:`Node3D.transform`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_visibility_parent: .. rst-class:: classref-method void **instance_set_visibility_parent** **(** :ref:`RID` instance, :ref:`RID` parent **)** Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instance_set_visible: .. rst-class:: classref-method void **instance_set_visible** **(** :ref:`RID` instance, :ref:`bool` visible **)** Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instances_cull_aabb: .. rst-class:: classref-method :ref:`PackedInt64Array` **instances_cull_aabb** **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** |const| Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as :ref:`MeshInstance3D` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instances_cull_convex: .. rst-class:: classref-method :ref:`PackedInt64Array` **instances_cull_convex** **(** :ref:`Plane[]` convex, :ref:`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` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_instances_cull_ray: .. rst-class:: classref-method :ref:`PackedInt64Array` **instances_cull_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`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` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_directional_set_blend_splits: .. rst-class:: classref-method void **light_directional_set_blend_splits** **(** :ref:`RID` light, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_directional_set_shadow_mode: .. rst-class:: classref-method void **light_directional_set_shadow_mode** **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** Sets the shadow mode for this directional light. Equivalent to :ref:`DirectionalLight3D.directional_shadow_mode`. See :ref:`LightDirectionalShadowMode` for options. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_directional_set_sky_mode: .. rst-class:: classref-method void **light_directional_set_sky_mode** **(** :ref:`RID` light, :ref:`LightDirectionalSkyMode` mode **)** 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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_omni_set_shadow_mode: .. rst-class:: classref-method void **light_omni_set_shadow_mode** **(** :ref:`RID` light, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_projectors_set_filter: .. rst-class:: classref-method void **light_projectors_set_filter** **(** :ref:`LightProjectorFilter` filter **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_bake_mode: .. rst-class:: classref-method void **light_set_bake_mode** **(** :ref:`RID` light, :ref:`LightBakeMode` bake_mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_color: .. rst-class:: classref-method void **light_set_color** **(** :ref:`RID` light, :ref:`Color` color **)** Sets the color of the light. Equivalent to :ref:`Light3D.light_color`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_cull_mask: .. rst-class:: classref-method void **light_set_cull_mask** **(** :ref:`RID` light, :ref:`int` mask **)** Sets the cull mask for this Light3D. Lights only affect objects in the selected layers. Equivalent to :ref:`Light3D.light_cull_mask`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_distance_fade: .. rst-class:: classref-method void **light_set_distance_fade** **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` shadow, :ref:`float` length **)** Sets the distance fade for this Light3D. This acts as a form of level of detail (LOD) and can be used to improve performance. Equivalent to :ref:`Light3D.distance_fade_enabled`, :ref:`Light3D.distance_fade_begin`, :ref:`Light3D.distance_fade_shadow`, and :ref:`Light3D.distance_fade_length`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_max_sdfgi_cascade: .. rst-class:: classref-method void **light_set_max_sdfgi_cascade** **(** :ref:`RID` light, :ref:`int` cascade **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_negative: .. rst-class:: classref-method void **light_set_negative** **(** :ref:`RID` light, :ref:`bool` enable **)** If ``true``, light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_param: .. rst-class:: classref-method void **light_set_param** **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** Sets the specified light parameter. See :ref:`LightParam` for options. Equivalent to :ref:`Light3D.set_param`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_projector: .. rst-class:: classref-method void **light_set_projector** **(** :ref:`RID` light, :ref:`RID` texture **)** Not implemented in Godot 3.x. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_reverse_cull_face_mode: .. rst-class:: classref-method void **light_set_reverse_cull_face_mode** **(** :ref:`RID` light, :ref:`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`. Equivalent to :ref:`Light3D.shadow_reverse_cull_face`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_light_set_shadow: .. rst-class:: classref-method void **light_set_shadow** **(** :ref:`RID` light, :ref:`bool` enabled **)** If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_create: .. rst-class:: classref-method :ref:`RID` **lightmap_create** **(** **)** Creates a new :ref:`LightmapGI` instance. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree: .. rst-class:: classref-method :ref:`PackedInt32Array` **lightmap_get_probe_capture_bsp_tree** **(** :ref:`RID` lightmap **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_points: .. rst-class:: classref-method :ref:`PackedVector3Array` **lightmap_get_probe_capture_points** **(** :ref:`RID` lightmap **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_sh: .. rst-class:: classref-method :ref:`PackedColorArray` **lightmap_get_probe_capture_sh** **(** :ref:`RID` lightmap **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra: .. rst-class:: classref-method :ref:`PackedInt32Array` **lightmap_get_probe_capture_tetrahedra** **(** :ref:`RID` lightmap **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization: .. rst-class:: classref-method void **lightmap_set_baked_exposure_normalization** **(** :ref:`RID` lightmap, :ref:`float` baked_exposure **)** Used to inform the renderer what exposure normalization value was used while baking the lightmap. This value will be used and modulated at run time to ensure that the lightmap maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_probe_bounds: .. rst-class:: classref-method void **lightmap_set_probe_bounds** **(** :ref:`RID` lightmap, :ref:`AABB` bounds **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_probe_capture_data: .. rst-class:: classref-method void **lightmap_set_probe_capture_data** **(** :ref:`RID` lightmap, :ref:`PackedVector3Array` points, :ref:`PackedColorArray` point_sh, :ref:`PackedInt32Array` tetrahedra, :ref:`PackedInt32Array` bsp_tree **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed: .. rst-class:: classref-method void **lightmap_set_probe_capture_update_speed** **(** :ref:`float` speed **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_probe_interior: .. rst-class:: classref-method void **lightmap_set_probe_interior** **(** :ref:`RID` lightmap, :ref:`bool` interior **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_lightmap_set_textures: .. rst-class:: classref-method void **lightmap_set_textures** **(** :ref:`RID` lightmap, :ref:`RID` light, :ref:`bool` uses_sh **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_make_sphere_mesh: .. rst-class:: classref-method :ref:`RID` **make_sphere_mesh** **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** Returns a mesh of a sphere with the given number of horizontal and vertical subdivisions. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_get_param: .. rst-class:: classref-method :ref:`Variant` **material_get_param** **(** :ref:`RID` material, :ref:`StringName` parameter **)** |const| Returns the value of a certain material's parameter. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_next_pass: .. rst-class:: classref-method void **material_set_next_pass** **(** :ref:`RID` material, :ref:`RID` next_material **)** Sets an object's next material. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_param: .. rst-class:: classref-method void **material_set_param** **(** :ref:`RID` material, :ref:`StringName` parameter, :ref:`Variant` value **)** Sets a material's parameter. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_render_priority: .. rst-class:: classref-method void **material_set_render_priority** **(** :ref:`RID` material, :ref:`int` priority **)** Sets a material's render priority. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_material_set_shader: .. rst-class:: classref-method void **material_set_shader** **(** :ref:`RID` shader_material, :ref:`RID` shader **)** Sets a shader material's shader. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_add_surface: .. rst-class:: classref-method void **mesh_add_surface** **(** :ref:`RID` mesh, :ref:`Dictionary` surface **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_add_surface_from_arrays: .. rst-class:: classref-method void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`ArrayFormat` compress_format=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_clear: .. rst-class:: classref-method void **mesh_clear** **(** :ref:`RID` mesh **)** Removes all surfaces from a mesh. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_create: .. rst-class:: classref-method :ref:`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` static method. To place in a scene, attach this mesh to an instance using :ref:`instance_set_base` using the returned RID. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_create_from_surfaces: .. rst-class:: classref-method :ref:`RID` **mesh_create_from_surfaces** **(** :ref:`Dictionary[]` surfaces, :ref:`int` blend_shape_count=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_blend_shape_count: .. rst-class:: classref-method :ref:`int` **mesh_get_blend_shape_count** **(** :ref:`RID` mesh **)** |const| Returns a mesh's blend shape count. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_blend_shape_mode: .. rst-class:: classref-method :ref:`BlendShapeMode` **mesh_get_blend_shape_mode** **(** :ref:`RID` mesh **)** |const| Returns a mesh's blend shape mode. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_custom_aabb: .. rst-class:: classref-method :ref:`AABB` **mesh_get_custom_aabb** **(** :ref:`RID` mesh **)** |const| Returns a mesh's custom aabb. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_surface: .. rst-class:: classref-method :ref:`Dictionary` **mesh_get_surface** **(** :ref:`RID` mesh, :ref:`int` surface **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_get_surface_count: .. rst-class:: classref-method :ref:`int` **mesh_get_surface_count** **(** :ref:`RID` mesh **)** |const| Returns a mesh's number of surfaces. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_set_blend_shape_mode: .. rst-class:: classref-method void **mesh_set_blend_shape_mode** **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** Sets a mesh's blend shape mode. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_set_custom_aabb: .. rst-class:: classref-method void **mesh_set_custom_aabb** **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** Sets a mesh's custom aabb. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_set_shadow_mesh: .. rst-class:: classref-method void **mesh_set_shadow_mesh** **(** :ref:`RID` mesh, :ref:`RID` shadow_mesh **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_arrays: .. rst-class:: classref-method :ref:`Array` **mesh_surface_get_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's buffer arrays. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays: .. rst-class:: classref-method :ref:`Array[]` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's arrays for blend shapes. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_attribute_stride** **(** :ref:`ArrayFormat` format, :ref:`int` vertex_count **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_offset: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_offset** **(** :ref:`ArrayFormat` format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_skin_stride** **(** :ref:`ArrayFormat` format, :ref:`int` vertex_count **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride: .. rst-class:: classref-method :ref:`int` **mesh_surface_get_format_vertex_stride** **(** :ref:`ArrayFormat` format, :ref:`int` vertex_count **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_get_material: .. rst-class:: classref-method :ref:`RID` **mesh_surface_get_material** **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| Returns a mesh's surface's material. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_set_material: .. rst-class:: classref-method void **mesh_surface_set_material** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** Sets a mesh's surface's material. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_update_attribute_region: .. rst-class:: classref-method void **mesh_surface_update_attribute_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_update_skin_region: .. rst-class:: classref-method void **mesh_surface_update_skin_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_mesh_surface_update_vertex_region: .. rst-class:: classref-method void **mesh_surface_update_vertex_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_allocate_data: .. rst-class:: classref-method void **multimesh_allocate_data** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_create: .. rst-class:: classref-method :ref:`RID` **multimesh_create** **(** **)** Creates a new multimesh on the RenderingServer and returns an :ref:`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` static method. To place in a scene, attach this multimesh to an instance using :ref:`instance_set_base` using the returned RID. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_aabb: .. rst-class:: classref-method :ref:`AABB` **multimesh_get_aabb** **(** :ref:`RID` multimesh **)** |const| Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_buffer: .. rst-class:: classref-method :ref:`PackedFloat32Array` **multimesh_get_buffer** **(** :ref:`RID` multimesh **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_instance_count: .. rst-class:: classref-method :ref:`int` **multimesh_get_instance_count** **(** :ref:`RID` multimesh **)** |const| Returns the number of instances allocated for this multimesh. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_mesh: .. rst-class:: classref-method :ref:`RID` **multimesh_get_mesh** **(** :ref:`RID` multimesh **)** |const| Returns the RID of the mesh that will be used in drawing this multimesh. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_get_visible_instances: .. rst-class:: classref-method :ref:`int` **multimesh_get_visible_instances** **(** :ref:`RID` multimesh **)** |const| Returns the number of visible instances for this multimesh. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_get_color: .. rst-class:: classref-method :ref:`Color` **multimesh_instance_get_color** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| Returns the color by which the specified instance will be modulated. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_get_custom_data: .. rst-class:: classref-method :ref:`Color` **multimesh_instance_get_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| Returns the custom data associated with the specified instance. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_get_transform: .. rst-class:: classref-method :ref:`Transform3D` **multimesh_instance_get_transform** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| Returns the :ref:`Transform3D` of the specified instance. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_get_transform_2d: .. rst-class:: classref-method :ref:`Transform2D` **multimesh_instance_get_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| Returns the :ref:`Transform2D` of the specified instance. For use when the multimesh is set to use 2D transforms. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_set_color: .. rst-class:: classref-method void **multimesh_instance_set_color** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_set_custom_data: .. rst-class:: classref-method void **multimesh_instance_set_custom_data** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** Sets the custom data for this instance. Custom data is passed as a :ref:`Color`, but is interpreted as a ``vec4`` in the shader. Equivalent to :ref:`MultiMesh.set_instance_custom_data`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_set_transform: .. rst-class:: classref-method void **multimesh_instance_set_transform** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform3D` transform **)** Sets the :ref:`Transform3D` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_instance_set_transform_2d: .. rst-class:: classref-method void **multimesh_instance_set_transform_2d** **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** Sets the :ref:`Transform2D` for this instance. For use when multimesh is used in 2D. Equivalent to :ref:`MultiMesh.set_instance_transform_2d`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_buffer: .. rst-class:: classref-method void **multimesh_set_buffer** **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_mesh: .. rst-class:: classref-method void **multimesh_set_mesh** **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_multimesh_set_visible_instances: .. rst-class:: classref-method void **multimesh_set_visible_instances** **(** :ref:`RID` multimesh, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_occluder_create: .. rst-class:: classref-method :ref:`RID` **occluder_create** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_occluder_set_mesh: .. rst-class:: classref-method void **occluder_set_mesh** **(** :ref:`RID` occluder, :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_omni_light_create: .. rst-class:: classref-method :ref:`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` static method. To place in a scene, attach this omni light to an instance using :ref:`instance_set_base` using the returned RID. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_create: .. rst-class:: classref-method :ref:`RID` **particles_collision_create** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_height_field_update: .. rst-class:: classref-method void **particles_collision_height_field_update** **(** :ref:`RID` particles_collision **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation: .. rst-class:: classref-method void **particles_collision_set_attractor_attenuation** **(** :ref:`RID` particles_collision, :ref:`float` curve **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_attractor_directionality: .. rst-class:: classref-method void **particles_collision_set_attractor_directionality** **(** :ref:`RID` particles_collision, :ref:`float` amount **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_attractor_strength: .. rst-class:: classref-method void **particles_collision_set_attractor_strength** **(** :ref:`RID` particles_collision, :ref:`float` setrngth **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_box_extents: .. rst-class:: classref-method void **particles_collision_set_box_extents** **(** :ref:`RID` particles_collision, :ref:`Vector3` extents **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_collision_type: .. rst-class:: classref-method void **particles_collision_set_collision_type** **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionType` type **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_cull_mask: .. rst-class:: classref-method void **particles_collision_set_cull_mask** **(** :ref:`RID` particles_collision, :ref:`int` mask **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_field_texture: .. rst-class:: classref-method void **particles_collision_set_field_texture** **(** :ref:`RID` particles_collision, :ref:`RID` texture **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_height_field_resolution: .. rst-class:: classref-method void **particles_collision_set_height_field_resolution** **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution` resolution **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_collision_set_sphere_radius: .. rst-class:: classref-method void **particles_collision_set_sphere_radius** **(** :ref:`RID` particles_collision, :ref:`float` radius **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_create: .. rst-class:: classref-method :ref:`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` static method. To place in a scene, attach these particles to an instance using :ref:`instance_set_base` using the returned RID. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_emit: .. rst-class:: classref-method void **particles_emit** **(** :ref:`RID` particles, :ref:`Transform3D` transform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` emit_flags **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_get_current_aabb: .. rst-class:: classref-method :ref:`AABB` **particles_get_current_aabb** **(** :ref:`RID` particles **)** Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_get_emitting: .. rst-class:: classref-method :ref:`bool` **particles_get_emitting** **(** :ref:`RID` particles **)** Returns ``true`` if particles are currently set to emitting. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_is_inactive: .. rst-class:: classref-method :ref:`bool` **particles_is_inactive** **(** :ref:`RID` particles **)** Returns ``true`` if particles are not emitting and particles are set to inactive. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_request_process: .. rst-class:: classref-method void **particles_request_process** **(** :ref:`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`, :ref:`instances_cull_convex`, or :ref:`instances_cull_ray`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_restart: .. rst-class:: classref-method void **particles_restart** **(** :ref:`RID` particles **)** Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_amount: .. rst-class:: classref-method void **particles_set_amount** **(** :ref:`RID` particles, :ref:`int` amount **)** Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_collision_base_size: .. rst-class:: classref-method void **particles_set_collision_base_size** **(** :ref:`RID` particles, :ref:`float` size **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_custom_aabb: .. rst-class:: classref-method void **particles_set_custom_aabb** **(** :ref:`RID` particles, :ref:`AABB` aabb **)** Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_draw_order: .. rst-class:: classref-method void **particles_set_draw_order** **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** Sets the draw order of the particles to one of the named enums from :ref:`ParticlesDrawOrder`. See :ref:`ParticlesDrawOrder` for options. Equivalent to :ref:`GPUParticles3D.draw_order`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_draw_pass_mesh: .. rst-class:: classref-method void **particles_set_draw_pass_mesh** **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** Sets the mesh to be used for the specified draw pass. Equivalent to :ref:`GPUParticles3D.draw_pass_1`, :ref:`GPUParticles3D.draw_pass_2`, :ref:`GPUParticles3D.draw_pass_3`, and :ref:`GPUParticles3D.draw_pass_4`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_draw_passes: .. rst-class:: classref-method void **particles_set_draw_passes** **(** :ref:`RID` particles, :ref:`int` count **)** Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_emission_transform: .. rst-class:: classref-method void **particles_set_emission_transform** **(** :ref:`RID` particles, :ref:`Transform3D` transform **)** Sets the :ref:`Transform3D` that will be used by the particles when they first emit. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_emitting: .. rst-class:: classref-method void **particles_set_emitting** **(** :ref:`RID` particles, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_explosiveness_ratio: .. rst-class:: classref-method void **particles_set_explosiveness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_fixed_fps: .. rst-class:: classref-method void **particles_set_fixed_fps** **(** :ref:`RID` particles, :ref:`int` fps **)** Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_fractional_delta: .. rst-class:: classref-method void **particles_set_fractional_delta** **(** :ref:`RID` particles, :ref:`bool` enable **)** If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_interpolate: .. rst-class:: classref-method void **particles_set_interpolate** **(** :ref:`RID` particles, :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_lifetime: .. rst-class:: classref-method void **particles_set_lifetime** **(** :ref:`RID` particles, :ref:`float` lifetime **)** Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_mode: .. rst-class:: classref-method void **particles_set_mode** **(** :ref:`RID` particles, :ref:`ParticlesMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_one_shot: .. rst-class:: classref-method void **particles_set_one_shot** **(** :ref:`RID` particles, :ref:`bool` one_shot **)** If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_pre_process_time: .. rst-class:: classref-method void **particles_set_pre_process_time** **(** :ref:`RID` particles, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_process_material: .. rst-class:: classref-method void **particles_set_process_material** **(** :ref:`RID` particles, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_randomness_ratio: .. rst-class:: classref-method void **particles_set_randomness_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_speed_scale: .. rst-class:: classref-method void **particles_set_speed_scale** **(** :ref:`RID` particles, :ref:`float` scale **)** Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_subemitter: .. rst-class:: classref-method void **particles_set_subemitter** **(** :ref:`RID` particles, :ref:`RID` subemitter_particles **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_trail_bind_poses: .. rst-class:: classref-method void **particles_set_trail_bind_poses** **(** :ref:`RID` particles, :ref:`Transform3D[]` bind_poses **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_trails: .. rst-class:: classref-method void **particles_set_trails** **(** :ref:`RID` particles, :ref:`bool` enable, :ref:`float` length_sec **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_transform_align: .. rst-class:: classref-method void **particles_set_transform_align** **(** :ref:`RID` particles, :ref:`ParticlesTransformAlign` align **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_particles_set_use_local_coordinates: .. rst-class:: classref-method void **particles_set_use_local_coordinates** **(** :ref:`RID` particles, :ref:`bool` enable **)** If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_positional_soft_shadow_filter_set_quality: .. rst-class:: classref-method void **positional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality` quality **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_create: .. rst-class:: classref-method :ref:`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` static method. To place in a scene, attach this reflection probe to an instance using :ref:`instance_set_base` using the returned RID. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_ambient_color: .. rst-class:: classref-method void **reflection_probe_set_ambient_color** **(** :ref:`RID` probe, :ref:`Color` color **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_ambient_energy: .. rst-class:: classref-method void **reflection_probe_set_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_ambient_mode: .. rst-class:: classref-method void **reflection_probe_set_ambient_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeAmbientMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_as_interior: .. rst-class:: classref-method void **reflection_probe_set_as_interior** **(** :ref:`RID` probe, :ref:`bool` enable **)** If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_cull_mask: .. rst-class:: classref-method void **reflection_probe_set_cull_mask** **(** :ref:`RID` probe, :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_enable_box_projection: .. rst-class:: classref-method void **reflection_probe_set_enable_box_projection** **(** :ref:`RID` probe, :ref:`bool` enable **)** If ``true``, uses box projection. This can make reflections look more correct in certain situations. Equivalent to :ref:`ReflectionProbe.box_projection`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_enable_shadows: .. rst-class:: classref-method void **reflection_probe_set_enable_shadows** **(** :ref:`RID` probe, :ref:`bool` enable **)** If ``true``, computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to :ref:`ReflectionProbe.enable_shadows`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_intensity: .. rst-class:: classref-method void **reflection_probe_set_intensity** **(** :ref:`RID` probe, :ref:`float` intensity **)** Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_max_distance: .. rst-class:: classref-method void **reflection_probe_set_max_distance** **(** :ref:`RID` probe, :ref:`float` distance **)** Sets the max distance away from the probe an object can be before it is culled. Equivalent to :ref:`ReflectionProbe.max_distance`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold: .. rst-class:: classref-method void **reflection_probe_set_mesh_lod_threshold** **(** :ref:`RID` probe, :ref:`float` pixels **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_origin_offset: .. rst-class:: classref-method void **reflection_probe_set_origin_offset** **(** :ref:`RID` probe, :ref:`Vector3` offset **)** Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to :ref:`ReflectionProbe.origin_offset`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_resolution: .. rst-class:: classref-method void **reflection_probe_set_resolution** **(** :ref:`RID` probe, :ref:`int` resolution **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_size: .. rst-class:: classref-method void **reflection_probe_set_size** **(** :ref:`RID` probe, :ref:`Vector3` size **)** Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_reflection_probe_set_update_mode: .. rst-class:: classref-method void **reflection_probe_set_update_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode` for options. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_request_frame_drawn_callback: .. rst-class:: classref-method void **request_frame_drawn_callback** **(** :ref:`Callable` callable **)** Schedules a callback to the given callable after a frame has been drawn. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_create: .. rst-class:: classref-method :ref:`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` static method. The scenario is the 3D world that all the visual instances exist in. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_set_camera_attributes: .. rst-class:: classref-method void **scenario_set_camera_attributes** **(** :ref:`RID` scenario, :ref:`RID` effects **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_set_environment: .. rst-class:: classref-method void **scenario_set_environment** **(** :ref:`RID` scenario, :ref:`RID` environment **)** Sets the environment that will be used with this scenario. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_scenario_set_fallback_environment: .. rst-class:: classref-method void **scenario_set_fallback_environment** **(** :ref:`RID` scenario, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_screen_space_roughness_limiter_set_active: .. rst-class:: classref-method void **screen_space_roughness_limiter_set_active** **(** :ref:`bool` enable, :ref:`float` amount, :ref:`float` limit **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_set_boot_image: .. rst-class:: classref-method void **set_boot_image** **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_set_debug_generate_wireframes: .. rst-class:: classref-method void **set_debug_generate_wireframes** **(** :ref:`bool` generate **)** If ``true``, the engine will generate wireframes for use with the wireframe debug mode. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_set_default_clear_color: .. rst-class:: classref-method void **set_default_clear_color** **(** :ref:`Color` color **)** Sets the default clear color which is used when a specific clear color has not been selected. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_get_code: .. rst-class:: classref-method :ref:`String` **shader_get_code** **(** :ref:`RID` shader **)** |const| Returns a shader's code. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_get_default_texture_parameter: .. rst-class:: classref-method :ref:`RID` **shader_get_default_texture_parameter** **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_get_parameter_default: .. rst-class:: classref-method :ref:`Variant` **shader_get_parameter_default** **(** :ref:`RID` shader, :ref:`StringName` name **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_set_code: .. rst-class:: classref-method void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_set_default_texture_parameter: .. rst-class:: classref-method void **shader_set_default_texture_parameter** **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`RID` texture, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_shader_set_path_hint: .. rst-class:: classref-method void **shader_set_path_hint** **(** :ref:`RID` shader, :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_allocate_data: .. rst-class:: classref-method void **skeleton_allocate_data** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_bone_get_transform: .. rst-class:: classref-method :ref:`Transform3D` **skeleton_bone_get_transform** **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| Returns the :ref:`Transform3D` set for a specific bone of this skeleton. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_bone_get_transform_2d: .. rst-class:: classref-method :ref:`Transform2D` **skeleton_bone_get_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| Returns the :ref:`Transform2D` set for a specific bone of this skeleton. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_bone_set_transform: .. rst-class:: classref-method void **skeleton_bone_set_transform** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform3D` transform **)** Sets the :ref:`Transform3D` for a specific bone of this skeleton. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_bone_set_transform_2d: .. rst-class:: classref-method void **skeleton_bone_set_transform_2d** **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** Sets the :ref:`Transform2D` for a specific bone of this skeleton. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_get_bone_count: .. rst-class:: classref-method :ref:`int` **skeleton_get_bone_count** **(** :ref:`RID` skeleton **)** |const| Returns the number of bones allocated for this skeleton. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_skeleton_set_base_transform_2d: .. rst-class:: classref-method void **skeleton_set_base_transform_2d** **(** :ref:`RID` skeleton, :ref:`Transform2D` base_transform **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_bake_panorama: .. rst-class:: classref-method :ref:`Image` **sky_bake_panorama** **(** :ref:`RID` sky, :ref:`float` energy, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_create: .. rst-class:: classref-method :ref:`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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_set_material: .. rst-class:: classref-method void **sky_set_material** **(** :ref:`RID` sky, :ref:`RID` material **)** Sets the material that the sky uses to render the background and reflection maps. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_set_mode: .. rst-class:: classref-method void **sky_set_mode** **(** :ref:`RID` sky, :ref:`SkyMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sky_set_radiance_size: .. rst-class:: classref-method void **sky_set_radiance_size** **(** :ref:`RID` sky, :ref:`int` radiance_size **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_spot_light_create: .. rst-class:: classref-method :ref:`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` static method. To place in a scene, attach this spot light to an instance using :ref:`instance_set_base` using the returned RID. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sub_surface_scattering_set_quality: .. rst-class:: classref-method void **sub_surface_scattering_set_quality** **(** :ref:`SubSurfaceScatteringQuality` quality **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_sub_surface_scattering_set_scale: .. rst-class:: classref-method void **sub_surface_scattering_set_scale** **(** :ref:`float` scale, :ref:`float` depth_scale **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_create: .. rst-class:: classref-method :ref:`RID` **texture_2d_create** **(** :ref:`Image` image **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_get: .. rst-class:: classref-method :ref:`Image` **texture_2d_get** **(** :ref:`RID` texture **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_layer_get: .. rst-class:: classref-method :ref:`Image` **texture_2d_layer_get** **(** :ref:`RID` texture, :ref:`int` layer **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_layered_create: .. rst-class:: classref-method :ref:`RID` **texture_2d_layered_create** **(** :ref:`Image[]` layers, :ref:`TextureLayeredType` layered_type **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_layered_placeholder_create: .. rst-class:: classref-method :ref:`RID` **texture_2d_layered_placeholder_create** **(** :ref:`TextureLayeredType` layered_type **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_placeholder_create: .. rst-class:: classref-method :ref:`RID` **texture_2d_placeholder_create** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_2d_update: .. rst-class:: classref-method void **texture_2d_update** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_3d_create: .. rst-class:: classref-method :ref:`RID` **texture_3d_create** **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` mipmaps, :ref:`Image[]` data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_3d_get: .. rst-class:: classref-method :ref:`Image[]` **texture_3d_get** **(** :ref:`RID` texture **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_3d_placeholder_create: .. rst-class:: classref-method :ref:`RID` **texture_3d_placeholder_create** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_3d_update: .. rst-class:: classref-method void **texture_3d_update** **(** :ref:`RID` texture, :ref:`Image[]` data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_get_path: .. rst-class:: classref-method :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_get_rd_texture: .. rst-class:: classref-method :ref:`RID` **texture_get_rd_texture** **(** :ref:`RID` texture, :ref:`bool` srgb=false **)** |const| Returns a texture :ref:`RID` that can be used with :ref:`RenderingDevice`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_proxy_create: .. rst-class:: classref-method :ref:`RID` **texture_proxy_create** **(** :ref:`RID` base **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_proxy_update: .. rst-class:: classref-method void **texture_proxy_update** **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_replace: .. rst-class:: classref-method void **texture_replace** **(** :ref:`RID` texture, :ref:`RID` by_texture **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_set_force_redraw_if_visible: .. rst-class:: classref-method void **texture_set_force_redraw_if_visible** **(** :ref:`RID` texture, :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_set_path: .. rst-class:: classref-method void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_texture_set_size_override: .. rst-class:: classref-method void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_attach_camera: .. rst-class:: classref-method void **viewport_attach_camera** **(** :ref:`RID` viewport, :ref:`RID` camera **)** Sets a viewport's camera. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_attach_canvas: .. rst-class:: classref-method void **viewport_attach_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Sets a viewport's canvas. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_attach_to_screen: .. rst-class:: classref-method void **viewport_attach_to_screen** **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2(0, 0, 0, 0), :ref:`int` screen=0 **)** Copies the viewport to a region of the screen specified by ``rect``. If :ref:`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 further optimization, see :ref:`viewport_set_render_direct_to_screen`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_create: .. rst-class:: classref-method :ref:`RID` **viewport_create** **(** **)** 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` static method. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_measured_render_time_cpu: .. rst-class:: classref-method :ref:`float` **viewport_get_measured_render_time_cpu** **(** :ref:`RID` viewport **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu: .. rst-class:: classref-method :ref:`float` **viewport_get_measured_render_time_gpu** **(** :ref:`RID` viewport **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_render_info: .. rst-class:: classref-method :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`ViewportRenderInfoType` type, :ref:`ViewportRenderInfo` info **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_get_texture: .. rst-class:: classref-method :ref:`RID` **viewport_get_texture** **(** :ref:`RID` viewport **)** |const| Returns the viewport's last rendered frame. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_remove_canvas: .. rst-class:: classref-method void **viewport_remove_canvas** **(** :ref:`RID` viewport, :ref:`RID` canvas **)** Detaches a viewport from a canvas and vice versa. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_active: .. rst-class:: classref-method void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** If ``true``, sets the viewport active, else sets it inactive. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_canvas_cull_mask: .. rst-class:: classref-method void **viewport_set_canvas_cull_mask** **(** :ref:`RID` viewport, :ref:`int` canvas_cull_mask **)** Sets the rendering mask associated with this :ref:`Viewport`. Only :ref:`CanvasItem` nodes with a matching rendering visibility layer will be rendered by this :ref:`Viewport`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_canvas_stacking: .. rst-class:: classref-method void **viewport_set_canvas_stacking** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_canvas_transform: .. rst-class:: classref-method void **viewport_set_canvas_transform** **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** Sets the transformation of a viewport's canvas. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_clear_mode: .. rst-class:: classref-method void **viewport_set_clear_mode** **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** Sets the clear mode of a viewport. See :ref:`ViewportClearMode` for options. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_debug_draw: .. rst-class:: classref-method void **viewport_set_debug_draw** **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw` for options. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter: .. rst-class:: classref-method void **viewport_set_default_canvas_item_texture_filter** **(** :ref:`RID` viewport, :ref:`CanvasItemTextureFilter` filter **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat: .. rst-class:: classref-method void **viewport_set_default_canvas_item_texture_repeat** **(** :ref:`RID` viewport, :ref:`CanvasItemTextureRepeat` repeat **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_disable_2d: .. rst-class:: classref-method void **viewport_set_disable_2d** **(** :ref:`RID` viewport, :ref:`bool` disable **)** If ``true``, the viewport's canvas is not rendered. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_disable_3d: .. rst-class:: classref-method void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_environment_mode: .. rst-class:: classref-method void **viewport_set_environment_mode** **(** :ref:`RID` viewport, :ref:`ViewportEnvironmentMode` mode **)** Sets the viewport's environment mode which allows enabling or disabling rendering of 3D environment over 2D canvas. When disabled, 2D will not be affected by the environment. When enabled, 2D will be affected by the environment if the environment background mode is :ref:`ENV_BG_CANVAS`. The default behavior is to inherit the setting from the viewport's parent. If the topmost parent is also set to :ref:`VIEWPORT_ENVIRONMENT_INHERIT`, then the behavior will be the same as if it was set to :ref:`VIEWPORT_ENVIRONMENT_ENABLED`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_fsr_sharpness: .. rst-class:: classref-method void **viewport_set_fsr_sharpness** **(** :ref:`RID` viewport, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_global_canvas_transform: .. rst-class:: classref-method void **viewport_set_global_canvas_transform** **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** Sets the viewport's global transformation matrix. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_measure_render_time: .. rst-class:: classref-method void **viewport_set_measure_render_time** **(** :ref:`RID` viewport, :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_msaa_2d: .. rst-class:: classref-method void **viewport_set_msaa_2d** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** Sets the multisample anti-aliasing mode for 2D/Canvas. See :ref:`ViewportMSAA` for options. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_msaa_3d: .. rst-class:: classref-method void **viewport_set_msaa_3d** **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** Sets the multisample anti-aliasing mode for 3D. See :ref:`ViewportMSAA` for options. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality: .. rst-class:: classref-method void **viewport_set_occlusion_culling_build_quality** **(** :ref:`ViewportOcclusionCullingBuildQuality` quality **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread: .. rst-class:: classref-method void **viewport_set_occlusion_rays_per_thread** **(** :ref:`int` rays_per_thread **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_parent_viewport: .. rst-class:: classref-method void **viewport_set_parent_viewport** **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** Sets the viewport's parent to another viewport. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision: .. rst-class:: classref-method void **viewport_set_positional_shadow_atlas_quadrant_subdivision** **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** Sets the shadow atlas quadrant's subdivision. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_size: .. rst-class:: classref-method void **viewport_set_positional_shadow_atlas_size** **(** :ref:`RID` viewport, :ref:`int` size, :ref:`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. \ **Note:** If this is set to ``0``, no shadows will be visible at all (including directional shadows). .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_render_direct_to_screen: .. rst-class:: classref-method void **viewport_set_render_direct_to_screen** **(** :ref:`RID` viewport, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_scaling_3d_mode: .. rst-class:: classref-method void **viewport_set_scaling_3d_mode** **(** :ref:`RID` viewport, :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_scaling_3d_scale: .. rst-class:: classref-method void **viewport_set_scaling_3d_scale** **(** :ref:`RID` viewport, :ref:`float` scale **)** Scales the 3D render buffer based on the viewport size uses an image filter specified in :ref:`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` 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. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_scenario: .. rst-class:: classref-method void **viewport_set_scenario** **(** :ref:`RID` viewport, :ref:`RID` scenario **)** Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas etc. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_screen_space_aa: .. rst-class:: classref-method void **viewport_set_screen_space_aa** **(** :ref:`RID` viewport, :ref:`ViewportScreenSpaceAA` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale: .. rst-class:: classref-method void **viewport_set_sdf_oversize_and_scale** **(** :ref:`RID` viewport, :ref:`ViewportSDFOversize` oversize, :ref:`ViewportSDFScale` scale **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_size: .. rst-class:: classref-method void **viewport_set_size** **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** Sets the viewport's width and height. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel: .. rst-class:: classref-method void **viewport_set_snap_2d_transforms_to_pixel** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel: .. rst-class:: classref-method void **viewport_set_snap_2d_vertices_to_pixel** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias: .. rst-class:: classref-method void **viewport_set_texture_mipmap_bias** **(** :ref:`RID` viewport, :ref:`float` mipmap_bias **)** Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). To get sharper textures at a distance without introducing too much graininess, set this between ``-0.75`` and ``0.0``. Enabling temporal antialiasing (:ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa`) can help reduce the graininess visible when using negative mipmap bias. \ **Note:** When the 3D scaling mode is set to FSR 1.0, this value is used to adjust the automatic mipmap bias which is calculated internally based on the scale factor. The formula for this is ``-log2(1.0 / scale) + mipmap_bias``. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_transparent_background: .. rst-class:: classref-method void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** If ``true``, the viewport renders its background as transparent. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_update_mode: .. rst-class:: classref-method void **viewport_set_update_mode** **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` constants for options. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_debanding: .. rst-class:: classref-method void **viewport_set_use_debanding** **(** :ref:`RID` viewport, :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_occlusion_culling: .. rst-class:: classref-method void **viewport_set_use_occlusion_culling** **(** :ref:`RID` viewport, :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_taa: .. rst-class:: classref-method void **viewport_set_use_taa** **(** :ref:`RID` viewport, :ref:`bool` enable **)** If ``true``, use Temporal Anti-Aliasing. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_use_xr: .. rst-class:: classref-method void **viewport_set_use_xr** **(** :ref:`RID` viewport, :ref:`bool` use_xr **)** If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_vrs_mode: .. rst-class:: classref-method void **viewport_set_vrs_mode** **(** :ref:`RID` viewport, :ref:`ViewportVRSMode` mode **)** Sets the Variable Rate Shading (VRS) mode for the viewport. Note, if hardware does not support VRS this property is ignored. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_viewport_set_vrs_texture: .. rst-class:: classref-method void **viewport_set_vrs_texture** **(** :ref:`RID` viewport, :ref:`RID` texture **)** Texture to use when the VRS mode is set to :ref:`VIEWPORT_VRS_TEXTURE`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_visibility_notifier_create: .. rst-class:: classref-method :ref:`RID` **visibility_notifier_create** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_visibility_notifier_set_aabb: .. rst-class:: classref-method void **visibility_notifier_set_aabb** **(** :ref:`RID` notifier, :ref:`AABB` aabb **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_visibility_notifier_set_callbacks: .. rst-class:: classref-method void **visibility_notifier_set_callbacks** **(** :ref:`RID` notifier, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_allocate_data: .. rst-class:: classref-method void **voxel_gi_allocate_data** **(** :ref:`RID` voxel_gi, :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3i` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_create: .. rst-class:: classref-method :ref:`RID` **voxel_gi_create** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_data_cells: .. rst-class:: classref-method :ref:`PackedByteArray` **voxel_gi_get_data_cells** **(** :ref:`RID` voxel_gi **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_distance_field: .. rst-class:: classref-method :ref:`PackedByteArray` **voxel_gi_get_distance_field** **(** :ref:`RID` voxel_gi **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_level_counts: .. rst-class:: classref-method :ref:`PackedInt32Array` **voxel_gi_get_level_counts** **(** :ref:`RID` voxel_gi **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_octree_cells: .. rst-class:: classref-method :ref:`PackedByteArray` **voxel_gi_get_octree_cells** **(** :ref:`RID` voxel_gi **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_octree_size: .. rst-class:: classref-method :ref:`Vector3i` **voxel_gi_get_octree_size** **(** :ref:`RID` voxel_gi **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform: .. rst-class:: classref-method :ref:`Transform3D` **voxel_gi_get_to_cell_xform** **(** :ref:`RID` voxel_gi **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization: .. rst-class:: classref-method void **voxel_gi_set_baked_exposure_normalization** **(** :ref:`RID` voxel_gi, :ref:`float` baked_exposure **)** Used to inform the renderer what exposure normalization value was used while baking the voxel gi. This value will be used and modulated at run time to ensure that the voxel gi maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure`. .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_bias: .. rst-class:: classref-method void **voxel_gi_set_bias** **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_dynamic_range: .. rst-class:: classref-method void **voxel_gi_set_dynamic_range** **(** :ref:`RID` voxel_gi, :ref:`float` range **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_energy: .. rst-class:: classref-method void **voxel_gi_set_energy** **(** :ref:`RID` voxel_gi, :ref:`float` energy **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_interior: .. rst-class:: classref-method void **voxel_gi_set_interior** **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_normal_bias: .. rst-class:: classref-method void **voxel_gi_set_normal_bias** **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_propagation: .. rst-class:: classref-method void **voxel_gi_set_propagation** **(** :ref:`RID` voxel_gi, :ref:`float` amount **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_quality: .. rst-class:: classref-method void **voxel_gi_set_quality** **(** :ref:`VoxelGIQuality` quality **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces: .. rst-class:: classref-method void **voxel_gi_set_use_two_bounces** **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)`